Funzione MprConfigInterfaceTransportEnum (mprapi.h)

Articolo
03/15/2023

La funzione MprConfigInterfaceTransportEnum enumera i trasporti configurati nell'interfaccia specificata.

Sintassi

DWORD MprConfigInterfaceTransportEnum(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                DWORD   dwLevel,
  [in, out]           LPBYTE  *lplpBuffer,
  [in]                DWORD   dwPrefMaxLen,
  [out]               LPDWORD lpdwEntriesRead,
  [out]               LPDWORD lpdwTotalEntries,
  [in, out, optional] LPDWORD lpdwResumeHandle
);

Parametri

[in] hMprConfig

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

[in] hRouterInterface

Gestire la configurazione dell'interfaccia da cui enumerare i trasporti. Ottenere questo handle chiamando MprConfigInterfaceCreate o MprConfigInterfaceEnum.

[in] dwLevel

Valore DWORD che descrive il formato in cui vengono restituite le informazioni nel parametro lplpBuffer . Deve essere zero.

[in, out] lplpBuffer

In input, un puntatore non NULL .

Al termine, un puntatore a una matrice di strutture MPR_IFTRANSPORT_0 . Liberare questo buffer di memoria chiamando MprConfigBufferFree.

[in] dwPrefMaxLen

Specifica la lunghezza massima preferita dei dati restituiti (in byte a 8 bit). Se questo parametro è -1, il buffer restituito è sufficiente per contenere tutte le informazioni disponibili.

[out] lpdwEntriesRead

Puntatore a una variabile DWORD . Questa variabile riceve il numero totale di voci enumerate dalla posizione di ripresa corrente.

[out] lpdwTotalEntries

Puntatore a una variabile DWORD . Questa variabile riceve il numero totale di voci che potrebbero essere state enumerate dalla posizione di ripresa corrente.

[in, out, optional] lpdwResumeHandle

Puntatore a una variabile DWORD .

In input, l'handle deve essere zero nella prima chiamata e lasciato invariato nelle chiamate successive.

In output, questa variabile contiene un handle di ripresa usato per continuare l'enumerazione. Se l'handle è NULL, l'enumerazione è completa.

Se si verifica un errore nell'enumerazione, questo handle non è valido.

Questo parametro è facoltativo e, Se l'applicazione chiamante specifica NULL per questo parametro, la funzione non restituisce un handle di ripresa.

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	Una delle seguenti condizioni è vera: hMprConfig è NULL. HRouterInterface è NULL. dwLevel non è zero. lplpBuffer è NULL. dwPrefMaxLen è minore delle dimensioni di una singola struttura MPR_IFTRANSPORT_0 . lpdwEntriesRead è NULL. lpdwTotalEntries è NULL.
ERROR_NOT_ENOUGH_MEMORY	Risorse insufficienti per completare l'operazione.
ERROR_NO_MORE_ITEMS	Non sono disponibili altre voci dalla posizione di ripresa corrente.
Altri	Usare FormatMessage per recuperare il messaggio di errore di sistema corrispondente al codice di errore restituito.

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