Funzione MprConfigGetFriendlyName (mprapi.h)

La funzione MprConfigGetFriendlyName restituisce il nome descrittivo di un'interfaccia che corrisponde al nome GUID specificato.

Sintassi

DWORD MprConfigGetFriendlyName(
  [in]  HANDLE hMprConfig,
  [in]  PWSTR  pszGuidName,
  [out] PWCHAR pszBuffer,
  [in]  DWORD  dwBufferSize
);

[in] hMprConfig

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

[in] pszGuidName

Puntatore a una stringa Unicode con terminazione Null che specifica il nome GUID per l'interfaccia.

[out] pszBuffer

Puntatore a un buffer che riceve il nome descrittivo per l'interfaccia.

[in] dwBufferSize

Specifica le dimensioni, in byte, del buffer a cui punta pszBuffer.

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

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

Valore	Significato
ERROR_BUFFER_OVERFLOW	Il buffer a cui punta pszBuffer non è sufficiente per contenere il nome GUID restituito.
ERROR_INVALID_PARAMETER	Uno dei parametri seguenti hMprConfig, pszGuidName o pszBuffer è NULL.
ERROR_NOT_FOUND	Non è stato trovato alcun nome GUID corrispondente al nome descrittivo specificato.

Requisito	Valore
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