MprAdminTransportSetInfo function (mprapi.h)

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

Syntax

DWORD MprAdminTransportSetInfo(
  [in]           MPR_SERVER_HANDLE hMprServer,
  [in]           DWORD             dwTransportId,
  [in, optional] LPBYTE            pGlobalInfo,
  [in]           DWORD             dwGlobalInfoSize,
  [in, optional] LPBYTE            pClientInterfaceInfo,
  [in]           DWORD             dwClientInterfaceInfoSize
);

Parameters

[in] hMprServer

Handle to the router on which information is being set. This handle is obtained from a previous call to MprAdminServerConnect.

[in] dwTransportId

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

[in, optional] pGlobalInfo

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.

[in] dwGlobalInfoSize

Specifies the size, in bytes, of the buffer 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] dwClientInterfaceInfoSize

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

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.

Requirements

See also

MprAdminServerConnect

MprAdminTransportGetInfo

Router Administration Functions

Router Management Reference