MprConfigInterfaceGetHandle function (mprapi.h)

  • Article

The MprConfigInterfaceGetHandle function retrieves a handle to the specified interface's configuration in the specified router configuration.

Syntax

DWORD MprConfigInterfaceGetHandle(
  [in]  HANDLE hMprConfig,
  [in]  LPWSTR lpwsInterfaceName,
  [out] HANDLE *phRouterInterface
);

Parameters

[in] hMprConfig

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

[in] lpwsInterfaceName

Pointer to a null-terminated Unicode string that specifies the name of the interface for which the configuration handle is requested. Use the interface GUID as the name of a LAN interface.

[out] phRouterInterface

Pointer to a handle variable. This variable receives a handle to the interface configuration.

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
ERROR_INVALID_PARAMETER
 The hMprConfig parameter is NULL, or the lpwsInterfaceName parameter is NULL, or both parameters are NULL.
ERROR_NOT_ENOUGH_MEMORY
 Insufficient resources to complete the operation.
ERROR_NO_SUCH_INTERFACE
 The specified interface was not found in the router configuration.
Other
 Use FormatMessage to retrieve the system error message that corresponds to the error code returned.
 
 

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

See also

FormatMessage

MprConfigServerConnect

Router Configuration Functions

Router Management Reference