MprConfigTransportGetInfo function (mprapi.h)

Article
10/13/2021

The MprConfigTransportGetInfo function retrieves the configuration for the specified transport protocol from the router.

Syntax

DWORD MprConfigTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterTransport,
  [in, out, optional] LPBYTE  *ppGlobalInfo,
  [out, optional]     LPDWORD lpdwGlobalInfoSize,
  [in, out, optional] LPBYTE  *ppClientInterfaceInfo,
  [out, optional]     LPDWORD lpdwClientInterfaceInfoSize,
  [in, out, optional] LPWSTR  *lplpwsDLLPath
);

Parameters

[in] hMprConfig

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

[in] hRouterTransport

Handle to the transport protocol configuration being retrieved. Obtain this handle by calling MprConfigTransportCreate, MprConfigTransportGetHandle, or MprConfigTransportEnum. Supported transport protocol types are listed on Transport Identifiers.

[in, out, optional] ppGlobalInfo

On input, pointer to a pointer variable.

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.

[out, optional] lpdwGlobalInfoSize

Pointer to a DWORD variable. This variable receives the size, in bytes, of the buffer returned through the ppGlobalInfo parameter.

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

[in, out, optional] ppClientInterfaceInfo

On input, pointer to a pointer variable.

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.

[out, optional] lpdwClientInterfaceInfoSize

Pointer to a DWORD variable. This variable receives the size, in bytes, of the buffer returned through the ppClientInterfaceInfo parameter.

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

[in, out, optional] lplpwsDLLPath

On input, pointer to a pointer to a null-terminated Unicode string.

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.

Return value

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: 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 protocol 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.

Remarks

If the pGlobalInfo, pClientInterfaceInfo, and lpwsDLLPath parameters are all NULL, the function does nothing and returns a value of NO_ERROR.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	mprapi.h
Library	Mprapi.lib
DLL	Mprapi.dll