MprConfigTransportGetInfo

[This is preliminary documentation and subject to change.]

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
);

Parameters

hMprConfig

Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.

hRouterTransport

Handle to the transport configuration being retrieved. Obtain this handle by calling MprConfigTransportCreate, MprConfigTransportGetHandle or MprConfigTransportEnum.

ppGlobalInfo

Pointer to a pointer variable. On successful return, this pointer variable will point to the global information for the transport. Free the buffer containing the global information by calling MprConfigBufferFree.

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 buffer returned through the ppGlobalInfo parameter.

This parameter is optional; the caller may specify NULL for this parameter. However, if ppGlobalInfo is not NULL, this parameter cannot be NULL.

ppClientInterfaceInfo

Pointer to a pointer variable. On successful return, this pointer will point to the default interface information for client routers for this transport. Free the buffer containing the interface information by calling MprConfigBufferFree.

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

lpdwClientInterfaceInfoSize

Pointer to a DWORD variable. On successful return, this variable will contain the size in bytes of the buffer returned through the ppClientInterfaceInfo parameter.

This parameter is optional; the caller may specify NULL for this parameter. However, if ppClientInterfaceInfo, is not NULL, this parameter cannot NULL.

lplpwsDLLPath

Pointer to a pointer to a Unicode string. On successful return, the Unicode string will contain the name of the router manager DLL for the specified transport.

This parameter is optional. If the caller specifies NULL for this parameter, the function will not retrieve the name of the router manager DLL.

Return Values

NO_ERROR

The information for the transport configuration was set successfully.

ERROR_INVALID_PARAMETER

At least one of the following is true:

hMprConfig is NULL

hRouterTransport is NULL

ppGlobalInfo is not NULL, but lpdwGlobalInfoSize is NULL.

ppClientInterfaceInfo is not NULL, but lpdwClientInterfaceInfo is NULL.

ERROR_UNKNOWN_PROTOCOL_ID

The transport configuration corresponding 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 corresponding to the error code returned.

Remarks

If the pGlobalInfo, pClientInterfaceInfo, and lpwsDLLPath parameters are all NULL, the function will do nothing, and return a value of NO_ERROR.

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

MprConfigBufferFree, MprConfigServerConnect, MprConfigTransportCreate, MprConfigTransportGetHandle, MprConfigTransportEnum