Funzione MprConfigInterfaceTransportGetInfo (mprapi.h)

Articolo
03/15/2023

La funzione MprConfigInterfaceTransportGetInfo recupera le informazioni di configurazione per il client specificato nell'interfaccia specificata.

Sintassi

DWORD MprConfigInterfaceTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                HANDLE  hRouterIfTransport,
  [in, out, optional] LPBYTE  *ppInterfaceInfo,
  [out, optional]     LPDWORD lpdwInterfaceInfoSize
);

Parametri

[in] hMprConfig

Gestire la configurazione del router. Ottenere questo handle chiamando MprConfigServerConnect.

[in] hRouterInterface

Gestire la configurazione dell'interfaccia da cui recuperare le informazioni client specificate. Ottenere questo handle chiamando MprConfigInterfaceCreate, MprConfigInterfaceGetHandle o MprConfigInterfaceEnum.

[in] hRouterIfTransport

Gestire la configurazione del trasporto da cui recuperare le informazioni client specificate. Ottenere questo handle chiamando MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle o MprConfigInterfaceTransportEnum. I tipi di protocollo di trasporto supportati sono elencati in Identificatori di trasporto.

[in, out, optional] ppInterfaceInfo

In input, puntatore a una variabile puntatore.

Nell'output, questa variabile puntatore punta a un'intestazione di informazioni che contiene informazioni di configurazione per il client. Usare le funzioni di intestazione delle informazioni per modificare le intestazioni delle informazioni. Liberare questa memoria chiamando MprConfigBufferFree.

Questo parametro è facoltativo e, Se l'applicazione chiamante specifica NULL per questo parametro, la funzione non restituisce le informazioni di configurazione.

[out, optional] lpdwInterfaceInfoSize

Puntatore a una variabile DWORD . Questa variabile riceve le dimensioni, in byte, dei dati a cui punta ppInterfaceInfo.

Questo parametro è facoltativo; l'applicazione chiamante può specificare NULL per questo parametro. Tuttavia, se ppInterfaceInfo non è NULL, questo parametro non può essere NULL. Per ulteriori informazioni, vedere la sezione Osservazioni di seguito in questo argomento.

Valore restituito

Se la funzione ha esito positivo, il valore restituito viene NO_ERROR. Per ulteriori informazioni, vedere la sezione Osservazioni di seguito in questo argomento.

Se la funzione ha esito negativo, il valore restituito è uno dei codici di errore seguenti.

Valore	Significato
ERROR_INVALID_PARAMETER	Una delle seguenti condizioni è vera: hMprConfig è NULL. hRouterInterface è NULL. hRouterIfTransport è NULL. ppInterfaceInfo non è NULL, ma lpdwInterfaceInfoSize è NULL.
ERROR_NO_SUCH_INTERFACE	L'interfaccia specificata da hRouterIfTransport non è stata trovata nella configurazione del router oppure il trasporto specificato da hRouterIfTransport non è stato abilitato nell'interfaccia specificata.
ERROR_NOT_ENOUGH_MEMORY	Risorse insufficienti per completare l'operazione.
Altri	Usare FormatMessage per recuperare il messaggio di errore di sistema corrispondente al codice di errore restituito.

Commenti

Se il parametro ppInterfaceInfo è NULL, MprConfigInterfaceTransportGetInfo non esegue alcuna operazione e restituisce immediatamente con un valore di NO_ERROR.

Requisiti


Client minimo supportato	Nessuno supportato
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	mprapi.h
Libreria	Mprapi.lib
DLL	Mprapi.dll