Sm_PolicyApi_GetVariableByName()

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

Sm_PolicyApi_GetVariableByName()

Gets a specified variable.

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

Type

Variable function.

Syntax

int SM_EXTERN Sm_PolicyApi_GetVariableByName (
   void*                       pSessionHandle,
   const char*                 pszVariableName,
   Sm_PolicyApi_Variable_t**   ppstructVariable
);

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.
pszDomainOid	I	A null-terminated string containing the object identifier of an existing Domain.
pszVariableName	I	Unique name that corresponds to a variable.
ppstructVariable	O	The address of a pointer to a variable structure.

Returns

Sm_PolicyApi_Success. The get was successful.
Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_Variable_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 obtain a variable.
Sm_PolicyApi_InvalidOid. The Domain OID was not found.
Sm_PolicyApi_NotFound. The variable name was not found.
Sm_PolicyApi_FeatureNotSupported. The client who called this function initialized the API with a version less than SM_POLICY_API_VERSION_6_0.