MprConfigGetFriendlyName function

The MprConfigGetFriendlyName function returns the friendly name for an interface that corresponds to the specified GUID name.

Syntax


DWORD MprConfigGetFriendlyName(
  _In_  HANDLE hMprConfig,
  _In_  PWCHAR pszGuidName,
  _Out_ PWCHAR pszBuffer,
  _In_  DWORD  dwBufferSize
);

Parameters

hMprConfig [in]

Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.

pszGuidName [in]

Pointer to a null-terminated Unicode string that specifies the GUID name for the interface.

pszBuffer [out]

Pointer to a buffer that receives the friendly name for the interface.

dwBufferSize [in]

Specifies the size, in bytes, of the buffer pointed to by pszBuffer.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

ValueMeaning
ERROR_BUFFER_OVERFLOW

The buffer pointed to by pszBuffer is not large enough to hold the returned GUID name.

ERROR_INVALID_PARAMETER

One of the following parameters hMprConfig, pszGuidName, or pszBuffer is NULL.

ERROR_NOT_FOUND

No GUID name was found that corresponds to the specified friendly name.

 

Remarks

For more information, see Avoiding Buffer Overruns.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Mprapi.h

Library

Mprapi.lib

DLL

Mprapi.dll

See also

Avoiding Buffer Overruns
Router Management Reference
Router Configuration Functions
MprConfigGetGuidName
MprConfigServerConnect

 

 

Community Additions

ADD
Show: