MprAdminTransportGetInfo

[This is preliminary documentation and subject to change.]

The MprAdminTransportGetInfo function retrieves global information, default client interface information, or both, for a specified transport.

DWORD  APIENTRY
MprAdminTransportGetInfo(
  MPR_SERVER_HANDLE hMprServer,          // handle to router
  DWORD dwTransportId,                   // identifies the transport
  LPBYTE * ppGlobalInfo,                 // buffer to receive global
                                         // information for transport 
  LPDWORD lpdwGlobalInfoSize,            // size of global information
                                         // returned
  LPBYTE * ppClientInterfaceInfo,        // buffer to receive client
                                         // interface information
  LPDWORD lpdwClientInterfaceInfoSize        // size of client interface
                                         // information returned
)

Parameters

hMprServer

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

dwTransportId

Identifies the transport about which to retrieve information.

ppGlobalInfo

Pointer to a pointer variable. On successful return, this variable will point to a global information for this transport. Free this memory by calling MprAdminBufferFree.

This parameter is optional. If the caller specifies NULL for this parameter, the function will not retrieve the global information.

lpdwGlobalInfoSize

Pointer to a DWORD variable. On successful return, this variable will contain the size in bytes of the global information for the transport.

ppClientInterfaceInfo

Pointer to a pointer variable. On successful return, this variable will point to default client interface information for this transport. Free this memory by calling MprAdminBufferFree.

This parameter is optional. If the caller specifies NULL for this parameter, the function will not retrieve the client interface information.

lpdwClientInterfaceInfoSize

Pointer to a DWORD variable. On successful return, this variable will contain the size in bytes of the client interface information.

Return Values

NO_ERROR

The information was retrieved successfully.

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_INVALID_PARAMETER

One of the following is true:

The ppGlobalInfo parameter and the ppClientInterfaceInfo parameter are both NULL.

The ppGlobalInfo parameter doesn't point to valid memory.

The ppClientInterfaceInfo parameter doesn't point to valid memory.

ERROR_NOT_ENOUGH_MEMORY

Insufficient resources to carry out the operation.

ERROR_UNKNOWN_PROTOCOL_ID

The dwTransportId value does not match any installed transport.

Remarks

The ppGlobalInfo and ppClientInterfaceInfo parameters cannot both be NULL.

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

MprAdminBufferFree, MprAdminServerConnect, MprAdminTransportSetInfo