Sm_PolicyApi_AddVariable()

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

Sm_PolicyApi_AddVariable()

Adds a variable object.

Type

Variable function.

Syntax

int SM_EXTERN Sm_PolicyApi_AddVariable (
   void*                      pSessionHandle,
   Sm_PolicyApi_Variable_t*   pstructVariable,
   const bool                 bUpdate
);

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.
pstructVariable	I	A pointer to a Sm_PolicyApi_Variable_t structure containing information about the variable.
bUpdate	I	A flag to indicate that if an existing object is found, it should be updated.

Returns

Sm_PolicyApi_Success. The add operation was successful.
Sm_PolicyApi_Failure. The add operation was not successful.
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 add a variable.
Sm_PolicyApi_FeatureNotSupported. The client who called this function initialized the API with a version less than SM_POLICY_API_VERSION_6_0.