MprAdminInterfaceSetInfo function

The MprAdminInterfaceSetInfo function sets information for a specified interface on a specified server.

Syntax


DWORD MprAdminInterfaceSetInfo(
  _In_ MPR_SERVER_HANDLE hMprServer,
  _In_ HANDLE            hInterface,
  _In_ DWORD             dwLevel,
  _In_ LPBYTE            lpbBuffer
);

Parameters

hMprServer [in]

Handle to the router to query. This handle is obtained from a previous call to MprAdminServerConnect.

hInterface [in]

Handle to the interface obtained by a previous call to MprAdminInterfaceCreate.

dwLevel [in]

A DWORD value that describes the format in which the information is structured in the lpbBuffer parameter. Acceptable values for dwLevel include 0, 1, 2, and 3, as listed in the following table.

ValueStructure Format
0 MPR_INTERFACE_0
1 MPR_INTERFACE_1
2 MPR_INTERFACE_2
3Windows Server 2008 or later: MPR_INTERFACE_3

 

lpbBuffer [in]

A pointer to a MPR_INTERFACE_0, MPR_INTERFACE_1, MPR_INTERFACE_2, or MPR_INTERFACE_3 structure. The dwLevel parameter indicates the type of structure.

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_ACCESS_DENIED

The calling application does not have sufficient privileges.

ERROR_INVALID_HANDLE

The hInterface value is invalid.

ERROR_INVALID_PARAMETER

The lplpbBuffer parameter is NULL.

ERROR_NOT_ENOUGH_MEMORY

Insufficient resources to complete the operation.

ERROR_NOT_SUPPORTED

The dwLevel value is invalid.

 

Remarks

The MprAdminInterfaceSetInfo function supports the MPR_INTERFACE_2 structure. However, MprConfigInterfaceSetInfo does not. In order to make persistent changes to a demand-dial interface, call MprAdminInterfaceSetInfo with MPR_INTERFACE_2, then call MprConfigInterfaceSetInfo with MPR_INTERFACE_0 or MPR_INTERFACE_1.

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 Administration Functions
MPR_INTERFACE_0
MPR_INTERFACE_1
MPR_INTERFACE_2
MPR_INTERFACE_3
MprAdminBufferFree
MprAdminInterfaceCreate
MprAdminInterfaceGetInfo
MprAdminServerConnect

 

 

Community Additions

ADD
Show: