MprAdminPortGetInfo

[This is preliminary documentation and subject to change.]

The MprAdminPortGetInfo function gets information for a specific port.

DWORD MprAdminPortGetInfo(
  RAS_SERVER_HANDLE hRasServer,    // handle to the server
  DWORD             dwLevel,       // level of info returned
  HANDLE            hPort,         // handle to port
  LPBYTE *          lplpbBuffer    // pointer returned data
);
 

Parameters

hRasServer

Handle to the Remote Access Server computer on which to collect port information. Obtain this handle by calling MprAdminServerConnect.

dwLevel

Specifies the format and content of the returned information. Acceptable values for dwLevel are zero or one. A value of zero will return a RAS_CONNECTION_0 structure; a value of one will return a RAS_CONNECTION_1 structure.

hPort

Handle to the port for which to collect information. Obtain this handle by calling MprAdminPortEnum.

lplpbBuffer

Pointer to a pointer variable that will point to a RAS_PORT_0 or RAS_PORT_1 structure on successful return. Free this memory by calling MprAdminBufferFree.

Return Values

If the function succeeds, the return value will be NO_ERROR.

If the function fails, the return value will be ERROR_INVALID_PARAMETER.

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

MprAdminServerConnect, MprAdminBufferFree, MprAdminPortEnum