Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The MprConfigGetFriendlyName function returns the friendly name for an interface that corresponds to the specified GUID name.
Syntax
DWORD MprConfigGetFriendlyName(
[in] HANDLE hMprConfig,
[in] PWSTR pszGuidName,
[out] PWCHAR pszBuffer,
[in] DWORD dwBufferSize
);
Parameters
[in] hMprConfig
Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.
[in] pszGuidName
Pointer to a null-terminated Unicode string that specifies the GUID name for the interface.
[out] pszBuffer
Pointer to a buffer that receives the friendly name for the interface.
[in] dwBufferSize
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.
Value | Meaning |
---|---|
|
The buffer pointed to by pszBuffer is not large enough to hold the returned GUID name. |
|
One of the following parameters hMprConfig, pszGuidName, or pszBuffer is NULL. |
|
No GUID name was found that corresponds to the specified friendly name. |
Remarks
For more information, see Avoiding Buffer Overruns.
Requirements
Requirement | Value |
---|---|
Minimum supported client | None supported |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Target Platform | Windows |
Header | mprapi.h |
Library | Mprapi.lib |
DLL | Mprapi.dll |