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 );
This parameter is optional; the calling application may specify NULL for this parameter.
This parameter is optional; the calling application may specify NULL for this parameter.
This parameter is optional; the calling application may specify NULL for this parameter.
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 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. |
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:
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.
Windows NT/2000: Requires Windows 2000.
Header: Declared in Mprapi.h.
Library: Use Mprapi.lib.
Router Management Reference, Router Configuration Functions, FormatMessage, MprConfigServerConnect, MprConfigTransportCreate, MprConfigTransportEnum, MprConfigTransportGetHandle