Sm_PolicyApi_GetResponseAttrs()

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

Sm_PolicyApi_GetResponseAttrs()

Retrieves a linked list of the response attributes that are associated with the response identified by pszResponseOid.

The linked list that is returned is referenced by the ppstructResponseAttr structure. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().

Type

Response function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetResponseAttrs (
   void*                           pSessionHandle,
   const char*                     pszResponseOid,
   Sm_PolicyApi_ResponseAttr_t**   ppstructResponseAttr
);

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.
ppstructResponseAttr	O	A pointer to a response attribute structure.

Returns

Sm_PolicyApi_Success. The get operation was successful.
Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_ResponseAttr_t.
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 get a list of response attributes.
Sm_PolicyApi_InvalidOid. The response OID was not found.

Email CA about this topic