Sm_PolicyApi_GetResponseByName()

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

Sm_PolicyApi_GetResponseByName()

Gets the contents of the response identified by pszResponseName and the corresponding pszDomainOid of the Domain in which the response exists.

The results of this function are returned in a structure referenced by ppstructResponse. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().

Type

Response function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetResponseByName (
   void*                      pSessionHandle,
   const char*                szDomainOid,
   const char*                pszResponseName,
   Sm_PolicyApi_Response_t**  ppstructResponse
);

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.
szDomainOid		A null-terminated string containing the object identifier of an existing Domain.
pszResponseName	I	A null-terminated string containing the name of an existing response.
ppstructResponse	O	The address of a pointer to a response structure.

Returns

Sm_PolicyApi_Success. The get operation was completed successfully.
Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_Response_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 response.
Sm_PolicyApi_InvalidOid. The Domain OID was not found.
Sm_PolicyApi_NotFound. The response name was not found.

Email CA about this topic