MprConfigInterfaceTransportSetInfo, fonction (mprapi.h)

Article
08/24/2023

La fonction MprConfigInterfaceTransportSetInfo met à jour les informations de configuration du client sur l’interface et le protocole de transport spécifiés.

Syntaxe

DWORD MprConfigInterfaceTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterInterface,
  [in]           HANDLE hRouterIfTransport,
  [in, optional] LPBYTE pInterfaceInfo,
  [in, optional] DWORD  dwInterfaceInfoSize
);

Paramètres

[in] hMprConfig

Gérez la configuration du routeur. Obtenez ce handle en appelant MprConfigServerConnect.

[in] hRouterInterface

Gérez la configuration de l’interface dans laquelle mettre à jour les informations. Obtenez ce handle en appelant MprConfigInterfaceCreate ou MprConfigInterfaceEnum.

[in] hRouterIfTransport

Gérez vers la configuration de transport dans laquelle mettre à jour les informations pour le client. Obtenez ce handle en appelant MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle ou MprConfigInterfaceTransportEnum. Les types de protocole de transport pris en charge sont répertoriés dans Identificateurs de transport.

[in, optional] pInterfaceInfo

Pointeur vers un en-tête d’informations qui contient des informations de configuration pour le client sur l’interface et le transport spécifiés. Le gestionnaire de routeur pour le transport spécifié interprète ces informations. Utilisez les fonctions d’en-tête d’informations pour manipuler les en-têtes d’informations.

Ce paramètre est facultatif. Si l’application appelante spécifie NULL pour ce paramètre, la fonction ne met pas à jour les informations de configuration du client.

[in, optional] dwInterfaceInfoSize

Spécifie la taille, en octets, des données pointées par pInterfaceInfo.

Ce paramètre est facultatif ; l’application appelante peut spécifier zéro pour ce paramètre. Toutefois, si pInterfaceInfo n’a pas la valeur NULL, ce paramètre ne peut pas être égal à zéro. Pour plus d'informations, consultez la section « Notes » plus loin dans cette rubrique.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR. Pour plus d'informations, consultez la section « Notes » plus loin dans cette rubrique.

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

Valeur	Signification
ERROR_INVALID_PARAMETER	Au moins un des éléments suivants est vrai : hMprConfig a la valeur NULL. hRouterInterface a la valeur NULL. hRouterIfTransport a la valeur NULL.
ERROR_NO_SUCH_INTERFACE	L’interface spécifiée par hRouterInterface n’est plus présente dans la configuration du routeur, ou le transport spécifié par hRouterInterface n’est plus présent sur l’interface.
Autres	Utilisez FormatMessage pour récupérer le message d’erreur système qui correspond au code d’erreur retourné.

Notes

Si le paramètre pInterfaceInfo a la valeur NULL, MprConfigInterfaceTransportSetInfo ne fait rien et retourne immédiatement avec une valeur de NO_ERROR.

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