MprConfigTransportSetInfo, fonction (mprapi.h)

Article
03/15/2023

La fonction MprConfigTransportSetInfo modifie la configuration du protocole de transport spécifié dans la configuration de routeur spécifiée.

Syntaxe

DWORD MprConfigTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterTransport,
  [in, optional] LPBYTE pGlobalInfo,
  [in, optional] DWORD  dwGlobalInfoSize,
  [in, optional] LPBYTE pClientInterfaceInfo,
  [in, optional] DWORD  dwClientInterfaceInfoSize,
  [in, optional] LPWSTR lpwsDLLPath
);

Paramètres

[in] hMprConfig

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

[in] hRouterTransport

Handle vers la configuration du protocole de transport en cours de mise à jour. Obtenez ce handle en appelant MprConfigTransportCreate, MprConfigTransportGetHandle ou MprConfigTransportEnum. Les types de protocole de transport pris en charge sont répertoriés dans Identificateurs de transport.

[in, optional] pGlobalInfo

Pointeur vers un en-tête d’informations qui spécifie des informations globales pour le protocole de transport. Le gestionnaire de routeur pour le transport 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 ; l’application appelante peut spécifier NULL pour ce paramètre.

[in, optional] dwGlobalInfoSize

Spécifie la taille, en octets, des données pointées par pGlobalInfo. Si l’application appelante spécifie NULL pour pGlobalInfo, l’application appelante doit spécifier zéro pour ce paramètre.

[in, optional] pClientInterfaceInfo

Pointeur vers un en-tête d’informations qui spécifie les informations d’interface par défaut pour les routeurs clients. Les informations sont utilisées pour configurer des interfaces dynamiques pour les routeurs clients pour ce transport. Utilisez les fonctions d’en-tête d’informations pour manipuler les en-têtes d’informations.

Ce paramètre est facultatif ; l’application appelante peut spécifier NULL pour ce paramètre.

[in, optional] dwClientInterfaceInfoSize

Spécifie la taille, en octets, des données pointées par pClientInterfaceInfo. Si l’application appelante spécifie NULL pour pClientInterfaceInfo, l’application appelante doit spécifier zéro pour ce paramètre.

[in, optional] lpwsDLLPath

Pointeur vers une chaîne Unicode terminée par null qui spécifie le nom de la DLL du gestionnaire de routeur pour le transport spécifié.

Ce paramètre est facultatif ; l’application appelante peut spécifier NULL pour ce paramètre.

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	Le paramètre hMprConfig est NULL, le paramètre hRouterTransport a la valeur NULL ou les deux sont NULL.
ERROR_UNKNOWN_PROTOCOL_ID	La configuration du protocole de transport qui correspond à hRouterTransport est introuvable dans la configuration du routeur.
Autres	Utilisez FormatMessage pour récupérer le message d’erreur système qui correspond au code d’erreur retourné.

Remarques

Utilisez MprConfigTransportSetInfo pour définir les informations globales du transport, les informations d’interface par défaut ou le nom de la DLL du gestionnaire de routeur pour le transport.

MprConfigTransportSetInfo tente de définir les éléments dans l’ordre dans lequel ils apparaissent dans la liste des paramètres :

Informations globales.
Informations d’interface par défaut pour les routeurs clients.
Nom de la DLL du gestionnaire de routeur.

Si MprConfigTransportSetInfo ne peut pas définir l’un des éléments, il retourne immédiatement sans tenter de définir les éléments restants.

Si les paramètres pGlobalInfo, pClientInterfaceInfo et lpwsDLLPath sont tous NULL, la fonction ne fait rien, renvoyant une valeur de NO_ERROR.

Configuration requise

Condition requise	Valeur
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