Funzione MprConfigTransportGetInfo (mprapi.h)

Articolo
08/24/2023

La funzione MprConfigTransportGetInfo recupera la configurazione per il protocollo di trasporto specificato dal router.

Sintassi

DWORD MprConfigTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterTransport,
  [in, out, optional] LPBYTE  *ppGlobalInfo,
  [out, optional]     LPDWORD lpdwGlobalInfoSize,
  [in, out, optional] LPBYTE  *ppClientInterfaceInfo,
  [out, optional]     LPDWORD lpdwClientInterfaceInfoSize,
  [in, out, optional] LPWSTR  *lplpwsDLLPath
);

Parametri

[in] hMprConfig

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

[in] hRouterTransport

Gestire la configurazione del protocollo di trasporto recuperata. Ottenere questo handle chiamando MprConfigTransportCreate, MprConfigTransportGetHandle o MprConfigTransportEnum. I tipi di protocollo di trasporto supportati sono elencati in Identificatori di trasporto.

[in, out, optional] ppGlobalInfo

In input, puntatore a una variabile puntatore.

Nell'output, questa variabile puntatore punta a un'intestazione di informazioni che contiene informazioni globali per il trasporto. Usare le funzioni di intestazione informazioni per modificare le intestazioni di informazioni. Liberare questo buffer chiamando MprConfigBufferFree.

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

[out, optional] lpdwGlobalInfoSize

Puntatore a una variabile DWORD . Questa variabile riceve le dimensioni, in byte, del buffer restituito tramite il parametro ppGlobalInfo .

Questo parametro è facoltativo; l'applicazione chiamante può specificare NULL per questo parametro. Tuttavia, se ppGlobalInfo non è NULL, questo parametro non può essere NULL.

[in, out, optional] ppClientInterfaceInfo

In input, puntatore a una variabile puntatore.

In output, questo puntatore punta a un'intestazione di informazioni che contiene informazioni di interfaccia predefinite per i router client per questo trasporto. Usare le funzioni di intestazione informazioni per modificare le intestazioni di informazioni. Liberare il buffer chiamando MprConfigBufferFree.

Questo parametro è facoltativo e, Se l'applicazione chiamante specifica NULL per questo parametro, la funzione non recupera le informazioni sull'interfaccia.

[out, optional] lpdwClientInterfaceInfoSize

Puntatore a una variabile DWORD . Questa variabile riceve le dimensioni, in byte, del buffer restituito tramite il parametro ppClientInterfaceInfo .

Questo parametro è facoltativo; l'applicazione chiamante può specificare NULL per questo parametro. Tuttavia, se ppClientInterfaceInfo non è NULL, questo parametro non può essere NULL.

[in, out, optional] lplpwsDLLPath

In input, puntatore a un puntatore a una stringa Unicode con terminazione null.

In output, la stringa Unicode riceve il nome della DLL di gestione router per il trasporto specificato.

Questo parametro è facoltativo e, Se l'applicazione chiamante specifica NULL per questo parametro, la funzione non recupera il nome della DLL di gestione router.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è NO_ERROR.

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

Valore	Significato
ERROR_INVALID_PARAMETER	Almeno uno dei seguenti è vero: hMprConfig è NULL hRouterTransport è NULL ppGlobalInfo non è NULL, ma lpdwGlobalInfoSize è NULL. ppClientInterfaceInfo non è NULL, ma lpdwClientInterfaceInfo è NULL.
ERROR_UNKNOWN_PROTOCOL_ID	La configurazione del protocollo di trasporto corrispondente a hRouterTransport non è stata trovata nella configurazione del router.
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 i parametri pGlobalInfo, pClientInterfaceInfo e lpwsDLLPath sono tutti NULL, la funzione non esegue nulla e restituisce 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