MprConfigInterfaceGetHandle

[This is preliminary documentation and subject to change.]

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

DWORD  MprConfigInterfaceGetHandle(
  HANDLE hMprConfig,            // handle to the router configuration
  LPWSTR lpwsInterfaceName,     // Unicode string containing name
                                // of interface
  HANDLE * phRouterInterface    // handle to the specified interface
);

Parameters

hMprConfig

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

lpwsInterfaceName

Pointer to a Unicode string containing the name of the interface for which the configuration handle is requested.

phRouterInterface

Pointer to a handle variable. On successful return, this variable contains a handle to the interface configuration.

Return Values

NO_ERROR

The configuration handle for the interface was retrieved successfully.

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 corresponding to the error code returned.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: Link with mprapi.lib.

See Also

FormatMessage, MprConfigServerConnect