MprAdminInterfaceTransportAdd function (mprapi.h)
The MprAdminInterfaceTransportAdd function adds a transport (for example, IP or IPX) to a specified interface.
Syntax
DWORD MprAdminInterfaceTransportAdd(
[in] MPR_SERVER_HANDLE hMprServer,
[in] HANDLE hInterface,
[in] DWORD dwTransportId,
[in] LPBYTE pInterfaceInfo,
[in] DWORD dwInterfaceInfoSize
);
Parameters
[in] hMprServer
Handle to the router on which information is being added. Obtain this handle by calling MprAdminServerConnect.
[in] hInterface
Handle to the interface on which the transport is being added. This handle is obtained by a previous call to MprAdminInterfaceCreate.
[in] dwTransportId
A DWORD value that describes the transport type to add to the interface. 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] pInterfaceInfo
Pointer to an information header that specifies interface information for this transport. Use the Information Header Functions to manipulate information headers.
[in] dwInterfaceInfoSize
Specifies the size, in bytes, of the information pointed to by pInterfaceInfo.
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 |
|---|---|
|
The calling application does not have sufficient privileges. |
|
The hInterface value is invalid. |
|
The pInterfaceInfo parameter is NULL. |
|
The dwTransportId value does not match any supported transport. |
Remarks
The dwTransportId parameter also specifies the router manager because a router uses a different router manager for each transport.
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
MprAdminInterfaceTransportRemove