Fonction RtmGetOpaqueInformationPointer (rtmv2.h)

La fonction RtmGetOpaqueInformationPointer retourne un pointeur vers le champ d’informations opaque dans une destination réservée à ce client. Le pointeur permet au client de stocker des informations spécifiques au client avec la destination dans la table de routage.

Syntaxe

DWORD RtmGetOpaqueInformationPointer(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_DEST_HANDLE   DestHandle,
  [out] PVOID             *OpaqueInfoPointer
);

Paramètres

[in] RtmRegHandle

Gérez le client obtenu à partir d’un appel précédent à RtmRegisterEntity.

[in] DestHandle

Handle vers la destination.

[out] OpaqueInfoPointer

En entrée, OpaqueInfoPointer est un pointeur vers NULL.

À la sortie, OpaqueInfoPointer reçoit un pointeur vers le pointeur d’informations opaques. Si un client n’a pas réservé de pointeur opaque pendant l’inscription, ce paramètre reste inchangé.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Valeur Signification
ERROR_INVALID_HANDLE
Le handle n'est pas valide.
ERROR_NOT_FOUND
Aucun pointeur opaque n’a été réservé par le client.
 
 

Notes

Pour obtenir un exemple de code utilisant cette fonction, consultez Accéder au pointeur opaque dans une destination.

Spécifications

   
Client minimal pris en charge Aucun pris en charge
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête rtmv2.h
Bibliothèque Rtm.lib
DLL Rtm.dll

Voir aussi

RtmLockDestination