MprConfigTransportSetInfo

[This is preliminary documentation and subject to change.]

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

DWORD  MprConfigTransportSetInfo(
  HANDLE hMprConfig,                  // handle to the router configuration
  HANDLE hRouterTransport,            // handle to the transport configuration
  LPBYTE pGlobalInfo,                 // global information for the transport
  DWORD dwGlobalInfoSize,             // size of global information
  LPBYTE pClientInterfaceInfo,        // interface information for
                                      // client routers
  DWORD dwClientInterfaceInfoSize,    // size of interface information
  LPWSTR lpwsDLLPath                  // 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 updated. Obtain this handle by calling MprConfigTransportCreate, MprConfigTransportGetHandle or MprConfigTransportEnum.

pGlobalInfo

Pointer to the global information for the transport. The router manager for the transport interprets this information.

dwGlobalInfoSize

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

pClientInterfaceInfo

Pointer to the default interface information for client routers. The information is used to configure dynamic interfaces for client routers for this transport.

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

dwClientInterfaceInfoSize

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

lpwsDLLPath

The name of the router manager DLL for the specified transport.

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

Return Values

NO_ERROR

The transport information was set successfully (however, see the remarks section below).

ERROR_INVALID_PARAMETER

The hMprConfig parameter is NULL, or the hRouterTransport parameter is NULL, or both are NULL.

ERROR_UNKNOWN_PROTOCOL_ID

The transport configuration corresponding to hRouterTransport was not found in the router configuration.

Other

Use FormatMessage to retrieve the system error message corresponding to the error code returned.

Remarks

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

The function 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 the function is unable to set any one of the items, it will return immediately without attempting to set the remaining items.

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

FormatMessage, MprConfigServerConnect, MprConfigTransportCreate, MprConfigTransportGetHandle, MprConfigTransportEnum