MprConfigTransportCreate
[This is preliminary documentation and subject to change.]
The MprConfigTransportCreate function adds the specified transport to the list of transports present in the specified router configuration.
DWORD MprConfigTransportCreate(
HANDLE hMprConfig, // handle to the router configuration
DWORD dwTransportId, // identifier of the transport/router
// manager
LPWSTR lpwsTransportName // address of the transport name
LPBYTE pGlobalInfo // address of the global info.,
DWORD dwGlobalInfoSize, // size of the global info buffer
LPBYTE pClientInterfaceInfo // address of info for client routers
DWORD dwClientInterfaceInfoSize, // size of the client info buffer
LPWSTR lpwsDLLPath // address of the router manager
// DLL name
HANDLE phRouterTransport // handle to the transport configuration
);
Parameters
-
hMprConfig
-
Handle to the router configuration to which to add the transport. Obtain this handle by calling MprConfigServerConnect.
-
dwTransportId
-
Identifies the transport to add to the configuration. This parameter also identifies the router manager for the transport.
-
lpwsTransportName
-
Pointer to a Unicode string containing the name of the transport being added. If this parameter is not specified, the dwTransportId parameter is converted into string and used as the transport name.
-
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.
-
pClientInterfaceInfo
-
Pointer to the default interface information for client routers. This 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
-
The size in bytes of the data pointed to by the pClientInterfaceInfo parameter. If the caller specifies NULL for pClientInterfaceInfo, the caller should specify zero for this parameter.
-
lpwsDLLPath
-
Pointer to a Unicode string containing the name of the router manager DLL for the specified transport. If specified, the function will set the DLLPath for this transport to this name.
This parameter is optional; the caller may specify NULL for this parameter.
-
phRouterTransport
-
Pointer to a handle variable. On successful return, this variable contains a handle to the transport configuration.
Return Values
-
NO_ERROR
-
Success.
-
ERROR_INVALID_PARAMETER
-
The hMprConfig parameter is NULL, or the phRouterTransport parameter is NULL, or both are NULL.
-
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 specified transport already exists, MprConfigTransportCreate does the equivalent of an MprConfigTransportSetInfo call using the supplied parameter values.
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