MprAdminTransportSetInfo

[This is preliminary documentation and subject to change.]

The MprAdminTransportSetInfo function sets global information, or default client interface information, or both, for a specified transport.

DWORD  APIENTRY
MprAdminTransportSetInfo(
  MPR_SERVER_HANDLE hMprServer,      // handle to router
  DWORD dwTransportId,               // identifies the transport
  LPBYTE pGlobalInfo,                // global information for transport
  DWORD dwGlobalInfoSize,            // size of global information
  LPBYTE pClientInterfaceInfo,       // information for client interfaces
  DWORD dwClientInterfaceInfoSize    // size of information for client
                                     // interfaces
)

hMprServer

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

dwTransportId

Identifies the transport for which to set information.

pGlobalInfo

Pointer to a buffer containing global information for the transport.

This parameter is optional. If the caller specifies NULL for this parameter, the function will not set the global information.

dwGlobalInfoSize

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

pClientInterfaceInfo

Pointer to a buffer containing default client interface information for the transport.

This parameter is optional. If the caller specifies NULL for this parameter, the function will not set the default client interface information.

dwClientInterfaceInfoSize

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

Return Values

NO_ERROR

The information was set successfully.

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_INVALID_PARAMETER

The pGlobalInfo parameter and the pClientInterfaceInfo parameter are both NULL.

ERROR_NOT_ENOUGH_MEMORY

Not enough resources to complete the operation.

ERROR_UNKNOWN_PROTOCOL_ID

The dwTransportId value does not match any installed transport.

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

MprAdminServerConnect, MprAdminTransportGetInfo