Sm_AgentApi_GetAllowedTunnelBufSize()

Retrieves the maximum data buffer size that can be transferred in the Sm_AgentApi_Tunnel() function call.

Syntax

long SM_EXTERN Sm_AgentApi_GetAllowedTunnelBufSize (
   void* pHandle,
   int nServer
);

Parameter	I/O	Description
pHandle	I	Agent API session handle returned in parameter ppHandle of Sm_AgentApi_Init().
nServer	I	The server that will process the request at the time of the tunnel call. One of these values, defined in smAgentAPI.h: /* server ports / / authorization server / #define SM_AGENTAPI_AZ_SERVER 0 / authentication server / #define SM_AGENTAPI_AUTH_SERVER 1 / accounting server */ #define SM_AGENTAPI_ACCT_SERVER 2

Parameter

I/O

Description

pHandle

Agent API session handle returned in parameter ppHandle of Sm_AgentApi_Init().

nServer

The server that will process the request at the time of the tunnel call. One of these values, defined in smAgentAPI.h:

/* server ports */

/* authorization server */
#define SM_AGENTAPI_AZ_SERVER 0

/* authentication server */
#define SM_AGENTAPI_AUTH_SERVER 1

/* accounting server */
#define SM_AGENTAPI_ACCT_SERVER 2

Returns

The maximum size of the buffer.

Remarks

This function was introduced in SDK v5.5. Beginning with that release, maximum allowable buffer sizes are larger than in previous releases.