MprAdminInterfaceConnect, fonction (mprapi.h)

Article
08/24/2023

La fonction MprAdminInterfaceConnect crée une connexion à l’interface WAN spécifiée.

Syntaxe

DWORD MprAdminInterfaceConnect(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] HANDLE            hEvent,
  [in] BOOL              fSynchronous
);

Paramètres

[in] hMprServer

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

[in] hInterface

Handle vers l’interface. Ce handle est obtenu à partir d’un appel précédent à MprAdminInterfaceCreate.

[in] hEvent

Gérez un événement signalé une fois la tentative de connexion de l’interface terminée. La fonction lance la tentative de connexion et retourne immédiatement. Une fois l’événement signalé, vous pouvez obtenir le résultat de la tentative de connexion en appelant MprAdminInterfaceGetInfo.

Si ce paramètre a la valeur NULL et que fBlocking a la valeur TRUE, cet appel est synchrone, c’est-à-dire que la fonction ne retourne pas tant que la tentative de connexion n’est pas terminée.

L’application appelante doit spécifier NULL pour ce paramètre, si hMprServer spécifie un routeur distant.

[in] fSynchronous

Si hEvent a la valeur NULL et que ce paramètre a la valeur TRUE, la fonction ne retourne pas tant que la tentative de connexion n’est pas terminée.

Si hEvent a la valeur NULL et que ce paramètre a la valeur FALSE, la fonction retourne immédiatement. La valeur de retour PENDING indique que la tentative de connexion a été lancée avec succès.

Si hEvent n’a pas la valeur NULL, ce paramètre est ignoré.

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_ALREADY_CONNECTING	Une connexion est déjà en cours sur cette interface.
ERROR_DDM_NOT_RUNNING	Le Gestionnaire de numérotation de la demande (DDM) n’est pas en cours d’exécution.
ERROR_INTERFACE_DISABLED	L’interface est actuellement désactivée.
ERROR_INTERFACE_HAS_NO_DEVICES	Aucun adaptateur n’est disponible pour cette interface.
ERROR_INVALID_HANDLE	La valeur hInterface n’est pas valide.
ERROR_SERVICE_IS_PAUSED	Le service Demand Dial est actuellement suspendu.
ATTENTE	L’interface est en cours de connexion. L’application appelante doit attendre le handle hEvent , s’il en a été spécifié. Une fois l’événement signalé, vous pouvez obtenir l’état de la connexion et toute erreur associée en appelant MprAdminInterfaceGetInfo.

Notes

Le tableau suivant récapitule la relation entre hEvent et fBlocking.

hEvent	fBlocking	Résultat
Handle d’événement	Ignoré	L’appel retourne immédiatement. La valeur de retour PENDING indique que la tentative a été lancée avec succès. Attendez sur hEvent. Lorsque hEvent est signalé, utilisez MprAdminInterfaceGetInfo pour déterminer la réussite ou l’échec de la tentative de connexion.
NULL	TRUE	L’appel ne retourne pas tant que la tentative de connexion n’est pas terminée.
NULL	FALSE	L’appel retourne immédiatement. La valeur de retour PENDING indique que la tentative a été lancée avec succès.

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