Sm_PolicyApi_AddResponseAttr()

Programming Guides › Programming Guide for C › Policy Management API Guidance › Function Declarations for the Policy Management API › Sm_PolicyApi_AddResponseAttr()

Sm_PolicyApi_AddResponseAttr()

Creates a new SiteMinder response attribute object within the response identified by pszResponseOid. The response attributes are contained in the pstructResponseAttr parameter.

Type

Response function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_AddResponseAttr (
   void*                         pSessionHandle,
   const char*                   pszResponseOid,
   Sm_PolicyApi_ResponseAttr_t*  pstructResponseAttr
);

Parameter	I/O	Description
pSessionHandle	I	A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pszResponseOid	I	A null-terminated string containing the object identifier of an existing response.
pstructResponseAttr	I	A pointer to a completely filled-in response structure.

Returns

Sm_PolicyApi_Success. The response attribute was added successfully.
Sm_PolicyApi_Failure. The response attribute was not added successfully.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to add a response attribute.
Sm_PolicyApi_InvalidOid:

The response OID was not found.

The agent type attribute OID was not found.