Edit

Share via

MprAdminInterfaceGetCustomInfoEx function (mprapi.h)

  • Article

Retrieves tunnel-specific configuration for a specified demand dial interface on a specified server.

Syntax

DWORD MprAdminInterfaceGetCustomInfoEx(
  [in]  MPR_SERVER_HANDLE    hMprServer,
  [in]  HANDLE               hInterface,
  [out] PMPR_IF_CUSTOMINFOEX pCustomInfo
);

Parameters

[in] hMprServer

A handle to the router to query. This handle is obtained by a previous call to the MprAdminServerConnect function.

[in] hInterface

A handle to the interface. This handle is obtained by a previous call to the MprAdminInterfaceCreate function.

[out] pCustomInfo

A pointer to a MPR_IF_CUSTOMINFOEX structure. When you have finished using the structure, free the memory by calling the MprAdminBufferFree function.

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.

Return code Description
ERROR_ACCESS_DENIED
 The calling application does not have sufficient privileges.
ERROR_INVALID_HANDLE
 The hInterface value is not valid.
ERROR_INVALID_PARAMETER
 The hInterface value is not valid or if the interface type is not ROUTER_IF_TYPE_FULL_ROUTER.
ERROR_NOT_ENOUGH_MEMORY
 There were insufficient resources to complete the operation.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

See also

Router Administration Functions

Router Management Reference