MprConfigGetGuidName function

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

Syntax


DWORD MprConfigGetGuidName(
  _In_  HANDLE hMprConfig,
  _In_  PWCHAR pszFriendlyName,
  _Out_ PWCHAR pszBuffer,
  _In_  DWORD  dwBufferSize
);

Parameters

hMprConfig [in]

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

pszFriendlyName [in]

Pointer to a Unicode string that specifies the friendly name for the interface.

pszBuffer [out]

Pointer to a buffer that receives the GUID 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

At least one of the parameters hMprConfig, pszFriendlyName, or pszBuffer is NULL.

ERROR_NOT_FOUND

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

 

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

Router Management Reference
Router Configuration Functions
MprConfigGetFriendlyName
MprConfigServerConnect

 

 

Community Additions

ADD
Show: