élément param

Modèle de contenu

param:==help

Attributs

  • @_operation (string)
  • @desc (string)
  • @enum (string)
  • @inout (string)
  • @label (string)
  • @localizable (string)
  • @name (MNTOKEN)
  • @namespace (MNTOKEN)
  • @type (string)

Parents

<parameters>

Enfants

<help>

Description

Cet élément permet de définir un paramètre d'un appel à une méthode SOAP.

Description des attributs

  • desc (string) : description qui concerne l’élément <param>.

  • inout (string): cet attribut définit si le paramètre est en entrée de l'appel SOAP (in) ou bien en sortie (out). Si cet attribut n'est pas précisé, le paramètre est par défaut en entrée ("@inout=in").

  • label (string) : libellé <param>

  • localizable (string): s'il est activé, cet attribut indique à l'outil de collecte de récupérer la valeur de l'attribut "@label" pour traduction (usage interne).

  • name (MNTOKEN): nom interne du <param>

  • type (string) : cet attribut définit le type d’élément <param>

    Liste des types disponibles :

    • ANY
    • bin
    • blob
    • boolean
    • byte
    • CDATA
    • datetime
    • datetimetz
    • datetimenotz
    • date
    • DOMDocument
    • DOMElement
    • double
    • enum
    • float
    • html
    • int64
    • link
    • long
    • memo
    • MNTOKEN
    • percent
    • primarykey
    • short
    • string
    • time
    • timespan
    • uuid

Exemples

Définition du paramètre en entrée "serviceName" de type chaîne de caractères:

<param desc="Name of the information service(s) (separated with commas)"
               name="serviceName" type="string" inout="in"/>

Sur cette page