MprAdminTransportGetInfo

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

DWORD 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
[in] Handle to the Windows 2000 router to query. This handle is obtained from a previous call to MprAdminServerConnect.
dwTransportId
[in] Specifies the transport about which to retrieve information.
ppGlobalInfo
[out] Pointer to a pointer variable. This variable points to an information header that receives global information for this transport. Use the Information Header Functions to manipulate information headers.

Free this memory by calling MprAdminBufferFree.

This parameter is optional. If the calling application specifies NULL for this parameter, the function does not retrieve the global information.

lpdwGlobalInfoSize
[out] Pointer to a DWORD variable. This variable receives the size, in bytes, of the global information for the transport.
ppClientInterfaceInfo
[out] Pointer to a pointer variable. This variable points to default client interface information for this transport. Free this memory by calling MprAdminBufferFree.

This parameter is optional. If the calling application specifies NULL for this parameter, the function does not retrieve the client interface information.

lpdwClientInterfaceInfoSize
[out] Pointer to a DWORD variable. This variable receives the size, in bytes, of the client interface information.

Return Values

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_ACCESS_DENIED The calling application does not have sufficient privileges.
ERROR_INVALID_PARAMETER One of the following is true:
  • The ppGlobalInfo parameter and the ppClientInterfaceInfo parameter are both NULL.
  • The ppGlobalInfo parameter does not point to valid memory.
  • The ppClientInterfaceInfo parameter does not point to valid memory.
ERROR_NOT_ENOUGH_MEMORY Insufficient resources to complete 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.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

Router Management Reference, Router Administration Functions, MprAdminBufferFree, MprAdminServerConnect, MprAdminTransportSetInfo