MprAdminTransportCreate

The MprAdminTransportCreate function loads a new transport, and starts the router manager for the transport.

DWORD MprAdminTransportCreate(
  MPR_SERVER_HANDLE hMprServer,
  DWORD dwTransportId,
  LPWSTR lpwsTransportName,
  LPBYTE pGlobalInfo,
  DWORD dwGlobalInfoSize,
  LPBYTE pClientInterfaceInfo,
  DWORD dwClientInterfaceInfoSize,
  LPWSTR lpwsDLLPath
);

Parameters

hMprServer
[in] Handle to the Windows 2000 router on which to set the information. Obtain this handle by calling MprAdminServerConnect.
dwTransportId
[in] Specifies the transport for which to set information.
lpwsTransportName
[in] Pointer to a null-terminated Unicode string that specifies the name of the transport.
pGlobalInfo
[in] Pointer to a buffer that specifies global information for the transport. Use the Information Header Functions to manipulate information headers.

This parameter is optional. If the calling application specifies NULL for this parameter, the function does not set the global information.

dwGlobalInfoSize
[in] Specifies the size, in bytes, of the buffer pointed to by the pGlobalInfo parameter.
pClientInterfaceInfo
[in] Pointer to a buffer that specifies default client interface information for the transport.

This parameter is optional. If the calling application specifies NULL for this parameter, the function does not set the default client interface information.

dwClientInterfaceInfoSize
[in] Specifies the size, in bytes, of the buffer pointed to by the pClientInterfaceInfo parameter.
lpwsDLLPath
[in] Pointer to a null-terminated Unicode string that specifies the path to the DLL for the transport.

Return Values

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_ACCESS_DENIED The calling application does not have sufficient privileges.
ERROR_INVALID_PARAMETER The pGlobalInfo parameter and the pClientInterfaceInfo parameter are both NULL.
ERROR_NOT_ENOUGH_MEMORY Insufficient resources to complete the operation.
ERROR_PROTOCOL_ALREADY_INSTALLED The specified transport is already running on the specified router.
ERROR_UNKNOWN_PROTOCOL_ID The dwTransportId value does not match any installed transport.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

MprAdminTransportGetInfo, MprAdminTransportSetInfo