Previous Topic: Sm_AgentApi_UnInit()Next Topic: Configuring Custom Agent Types

Programming Guides › Programming Guide for C › Guidance for the Agent API in C › Agent API Function Declarations (C) › Sm_AgentApi_UpdateAttributes()

Sm_AgentApi_UpdateAttributes()

Call this function to update response attributes when the time-to-live (TTL) value has expired. When specifying request attributes, each attribute structure should be zero-initialized, then set the lpszAttributeOid fields in the Sm_AgentApi_Attribute_t structure. Use the same field to map the response attributes to requested attributes. Not all attributes may be updated.

This function will recalculate an active response that originally held no data. An active response attribute is considered valid if its return value has a non-zero length or its TTL value is set.

Syntax

int SM_EXTERN Sm_AgentApi_UpdateAttributes (
   const void*                          pHandle,
   const char*                          lpszClientIpAddr,
   const char*                          lpszTransactionId,
   const Sm_AgentApi_ResourceContext_t* pResourceContext,
   const Sm_AgentApi_Realm_t*           pRealm,
   const Sm_AgentApi_Session_t*         pSession,
   long                                 nNumReqAttributes,
   Sm_AgentApi_Attribute_t*             pReqAttributes,
   long*                                pRespNumAttributes,
   Sm_AgentApi_Attribute_t**            ppRespAttributes
);

Parameter

I/O

Description

pHandle

I

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

lpszClientIpAddr

I

The IP address of the client that the user is logging from. This is an optional parameter. If the client IP begins with a star (*), the Policy Server logs the IP address but does not validate it against a session specification.

lpszTransactionId

I

The ID that the agent uses to associate application activity with security activity. The Policy Server logs this ID. This is an optional parameter.

pResourceContext

I

A resource definition structure.

pRealm

O

A realm definition structure.

pSession

I

A session definition structure.

nNumReqAttributes

I

The number of attributes in pReqAttributes.

pReqAttributes

I

An array of requested attribute definition structures.

pRespNumAttributes

O

The number of attributes in ppRespAttributes.

ppRespAttributes

O

An array of response attribute definition structures.

Returns