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 );
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.
This parameter is optional. If the calling application specifies NULL for this parameter, the function does not retrieve the client interface information.
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:
|
ERROR_NOT_ENOUGH_MEMORY | Insufficient resources to complete the operation. |
ERROR_UNKNOWN_PROTOCOL_ID | The dwTransportId value does not match any installed transport. |
The ppGlobalInfo and ppClientInterfaceInfo parameters cannot both be NULL.
Windows NT/2000: Requires Windows 2000.
Header: Declared in Mprapi.h.
Library: Use Mprapi.lib.
Router Management Reference, Router Administration Functions, MprAdminBufferFree, MprAdminServerConnect, MprAdminTransportSetInfo