The MprConfigTransportGetInfo function retrieves the configuration for the specified transport from the router.
DWORD MprConfigTransportGetInfo( HANDLE hMprConfig, // handle to the router configuration HANDLE hRouterTransport, // handle to the transport configuration LPBYTE *ppGlobalInfo, // global information for the transport LPDWORD lpdwGlobalInfoSize, // size of global information LPBYTE *ppClientInterfaceInfo, // interface information for client // routers LPDWORD lpdwClientInterfaceInfoSize, // size of interface information LPWSTR *lplpwsDLLPath // name of router manager DLL );
On output, this pointer variable points to an information header that contains global information for the transport. Use the Information Header Functions to manipulate information headers. Free this buffer by calling MprConfigBufferFree.
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; the calling application may specify NULL for this parameter. However, if ppGlobalInfo is not NULL, this parameter cannot be NULL.
On output, this pointer points to an information header that contains default interface information for client routers for this transport. Use the Information Header Functions to manipulate information headers. Free the buffer by calling MprConfigBufferFree.
This parameter is optional. If the calling application specifies NULL for this parameter, the function does not retrieve the interface information.
This parameter is optional; the calling application may specify NULL for this parameter. However, if ppClientInterfaceInfo is not NULL, this parameter cannot be NULL.
On output, the Unicode string receives the name of the router manager DLL for the specified transport.
This parameter is optional. If the calling application specifies NULL for this parameter, the function does not retrieve the name of the router manager DLL.
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_INVALID_PARAMETER | At least one of the following is true:
|
ERROR_UNKNOWN_PROTOCOL_ID | The transport configuration that corresponds to hRouterTransport was not found in the router configuration. |
ERROR_NOT_ENOUGH_MEMORY | Insufficient resources to complete the operation. |
Other | Use FormatMessage to retrieve the system error message that corresponds to the error code returned. |
If the pGlobalInfo, pClientInterfaceInfo, and lpwsDLLPath parameters are all NULL, the function does nothing and returns a value of NO_ERROR.
Windows NT/2000: Requires Windows 2000.
Header: Declared in Mprapi.h.
Library: Use Mprapi.lib.
Router Management Reference, Router Configuration Functions, FormatMessage, Information Header Functions, MprConfigBufferFree, MprConfigServerConnect, MprConfigTransportCreate, MprConfigTransportEnum, MprConfigTransportGetHandle