Edit

Share via

MprAdminTransportCreate function (mprapi.h)

  • Article

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

Syntax

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

Parameters

[in] hMprServer

Handle to the router on which to set the information. Obtain this handle by calling MprAdminServerConnect.

[in] dwTransportId

A DWORD value that describes the transport configuration type to set. Acceptable values for dwTransportId are listed in the following table.

Value Transport (Protocol Family)
PID_ATALK AppleTalk
PID_IP Internet Protocol version 4
PID_IPX Internet Packet Exchange
PID_NBF NetBIOS Frames Protocol
PID_IPV6 Windows Server 2008 or later: Internet Protocol version 6

[in, optional] lpwsTransportName

Pointer to a null-terminated Unicode string that specifies the name of the transport.

[in] pGlobalInfo

Pointer to a buffer that specifies global information for the transport. Use the Information Header Functions to manipulate information headers.

[in] dwGlobalInfoSize

Specifies the size, in bytes, of the data pointed to by the pGlobalInfo parameter.

[in, optional] pClientInterfaceInfo

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.

[in, optional] dwClientInterfaceInfoSize

Specifies the size, in bytes, of the buffer pointed to by the pClientInterfaceInfo parameter.

[in] lpwsDLLPath

Pointer to a null-terminated Unicode string that specifies the path to the DLL for the transport.

Return value

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 supported transport protocol.

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

MprAdminTransportGetInfo

MprAdminTransportSetInfo