MprAdminConnectionGetInfo

[This is preliminary documentation and subject to change.]

The MprAdminConnectionGetInfo function provides information on a specific connection.

DWORD MprAdminConnectionGetInfo(
  RAS_SERVER_HANDLE hRasServer,    // handle to server
  DWORD             dwLevel,       // level of info returned
  HANDLE            hConnection,   // handle to connection
  LPBYTE *          lplpbBuffer    // pointer to returned info
);
 

Parameters

hRasServer

Handle to the Windows NT Routing and RAS machine on which connection information will be gathered. 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

hConnection

Handle to the connection for which to obtain information. Obtain this handle by calling MprAdminConnectionEnum.

lplpbBuffer

Pointer to a pointer variable that will point to a RAS_CONNECTION_0 or RAS_CONNECTION_1 structure upon successful execution. 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, MprAdminConnectionEnum, RAS_CONNECTION_0, RAS_CONNECTION_1