MprConfigTransportSetInfo function (mprapi.h)

  • Article

The MprConfigTransportSetInfo function changes the configuration for the specified transport protocol in the specified router configuration.

Syntax

DWORD MprConfigTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterTransport,
  [in, optional] LPBYTE pGlobalInfo,
  [in, optional] DWORD  dwGlobalInfoSize,
  [in, optional] LPBYTE pClientInterfaceInfo,
  [in, optional] DWORD  dwClientInterfaceInfoSize,
  [in, optional] LPWSTR lpwsDLLPath
);

Parameters

[in] hMprConfig

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

[in] hRouterTransport

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

[in, optional] pGlobalInfo

Pointer to an information header that specifies global information for the transport protocol. The router manager for the transport interprets this information. Use the Information Header Functions to manipulate information headers.

This parameter is optional; the calling application may specify NULL for this parameter.

[in, optional] dwGlobalInfoSize

Specifies the size, in bytes, of the data pointed to by pGlobalInfo. If the calling application specifies NULL for pGlobalInfo, the calling application should specify zero for this parameter.

[in, optional] pClientInterfaceInfo

Pointer to an information header that specifies default interface information for client routers. The information is used to configure dynamic interfaces for client routers for this transport. Use the Information Header Functions to manipulate information headers.

This parameter is optional; the calling application can specify NULL for this parameter.

[in, optional] dwClientInterfaceInfoSize

Specifies the size, in bytes, of the data pointed to by pClientInterfaceInfo. If the calling application specifies NULL for pClientInterfaceInfo, the calling application should specify zero for this parameter.

[in, optional] lpwsDLLPath

Pointer to a null-terminated Unicode string that specifies the name of the router manager DLL for the specified transport.

This parameter is optional; the calling application may specify NULL for this parameter.

Return value

If the function succeeds, the return value is NO_ERROR. For more information, see the Remarks section later in this topic.

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

Value Meaning
ERROR_INVALID_PARAMETER
 The hMprConfig parameter is NULL, the hRouterTransport parameter is NULL, or both are NULL.
ERROR_UNKNOWN_PROTOCOL_ID
 The transport protocol configuration that corresponds to hRouterTransport was not found in the router configuration.
Other
 Use FormatMessage to retrieve the system error message that corresponds to the error code returned.
 
 

Remarks

Use MprConfigTransportSetInfo to set the transport's global information, default interface information, or the name of the router manager DLL for the transport.

MprConfigTransportSetInfo attempts to set the items in the order in which they appear in the parameter list:

  1. Global information.
  2. Default interface information for client routers.
  3. Router manager DLL name.
If MprConfigTransportSetInfo is unable to set any one of the items, it returns immediately without attempting to set the remaining items.

If the pGlobalInfo, pClientInterfaceInfo, and lpwsDLLPath parameters are all NULL, the function does nothing, returning 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

See also

FormatMessage

MprConfigServerConnect

MprConfigTransportCreate

MprConfigTransportEnum

MprConfigTransportGetHandle

Router Configuration Functions

Router Management Reference