retval (attribut)

  • Article

L’attribut [retval] désigne le paramètre qui reçoit la valeur de retour du membre.

return-type function-name(
    [out, retval [, optional-attributes]] data-type * param-name,
    ...);

Paramètres

return-type

Type de données de la valeur de retour de la procédure distante.

function-name

Nom utilisé pour appeler la procédure distante.

optional-attributes

Zéro ou plusieurs attributs MIDL.

type de données

Type des données transmises via le paramètre .

param-name

Nom d’identificateur du paramètre.

Notes

Vous pouvez utiliser l’attribut [retval] sur les paramètres des membres de l’interface qui décrivent des méthodes ou obtiennent des propriétés. (L’attribut est requis sur le dernier paramètre d’une méthode qui a l’attribut [propget]. ) Le paramètre doit avoir l’attribut [out] et doit être un type pointeur.

Vous ne pouvez pas appliquer l’attribut [facultatif] à un paramètre [retval].

Le compilateur MIDL accepte le classement des paramètres suivant (de gauche à droite) :

  1. Paramètres obligatoires (paramètres qui n’ont pas les attributs [valeur_default] ou [facultatif] ).
  2. Paramètres facultatifs avec ou sans l’attribut [defaultvalue].
  3. Paramètres avec l’attribut [facultatif] et sans l’attribut [defaultvalue].
  4. [lcid] paramètre, le cas échéant.
  5. Paramètre [retval].

Les paramètres avec l’attribut [retval] ne sont pas affichés dans les navigateurs orientés utilisateur.

Indicateurs

IDLFLAG_FRETVAL

Exemples

HRESULT MyMethod([out, retval] InMyFace** ReturnVal);
HRESULT MyOtherMethod([out, retval] VARIANT_BOOL* ReturnVal);

Voir aussi

Defaultvalue

Génération d’une bibliothèque de types avec MIDL

lcid

Exemple de fichier ODL

Syntaxe de fichier ODL

Optionnel

out

propget

TYPEFLAGS