MprAdminInterfaceGetHandle, fonction (mprapi.h)

Article
08/24/2023

La fonction MprAdminInterfaceGetHandle récupère un handle dans une interface spécifiée.

Syntaxe

DWORD MprAdminInterfaceGetHandle(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  LPWSTR            lpwsInterfaceName,
  [out] HANDLE            *phInterface,
  [in]  BOOL              fIncludeClientInterfaces
);

Paramètres

[in] hMprServer

Gérez le routeur sur lequel exécuter cet appel. Obtenez ce handle en appelant MprAdminServerConnect.

[in] lpwsInterfaceName

Pointeur vers une chaîne Unicode terminée par null qui spécifie le nom de l’interface à récupérer.

[out] phInterface

Pointeur vers une variable HANDLE qui reçoit un handle vers l’interface spécifiée par lpwsInterfaceName.

[in] fIncludeClientInterfaces

Spécifie si la fonction retourne une interface cliente. Si ce paramètre a la valeur FALSE, les interfaces de type ROUTER_IF_TYPE_CLIENT sont ignorées dans la recherche de l’interface avec le nom spécifié par lpwsInterfaceName. Si ce paramètre a la valeur TRUE et qu’une interface portant le nom spécifié existe, MprAdminInterfaceGetHandle retourne un handle à une interface de type ROUTER_IF_TYPE_CLIENT. Étant donné qu’il est possible qu’il existe plusieurs interfaces de type ROUTER_IF_TYPE_CLIENT, le handle retourné référence la première interface trouvée avec le nom spécifié par lpwsInterfaceName.

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_ACCESS_DENIED	L’application appelante ne dispose pas de privilèges suffisants.
ERROR_NO_SUCH_INTERFACE	Il n’existe aucune interface avec le nom spécifié par lpwsInterfaceName.
RPC_S_INVALID_BINDING	Le handle passé au serveur est NULL.
RPC_X_NULL_REF_POINTER	lpwsInterfaceName a la valeur NULL.

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	mprapi.h
Bibliothèque	Mprapi.lib
DLL	Mprapi.dll

Voir aussi

MprAdminServerConnect

ROUTER_INTERFACE_TYPE

Fonctions d’administration du routeur

Informations de référence sur la gestion des routeurs

Partager via