Sm_PolicyApi_GetGlobalPolicyByName()

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

Sm_PolicyApi_GetGlobalPolicyByName()

Gets a specified global policy.

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

Type

Administrator function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetGlobalPolicyByName (
   void*                    pHandle,
   const char*              szPolicyName,
   Sm_PolicyApi_Policy_t**  ppstructPolicy
);

Parameter	I/O	Description
pHandle	I	A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
szPolicyName	I	Unique name that corresponds to a global policy.
ppstructPolicy	O	The address of a pointer to a policy structure.

Returns

Sm_PolicyApi_Success. The get operation was successful.
Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_Policy_t.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get a policy.
Sm_PolicyApi_NotFound. The policy name was not found.