Sm_PolicyApi_AddAgentConfigAssociation()

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

Sm_PolicyApi_AddAgentConfigAssociation()

Adds or modifies a configuration parameter name and corresponding value in a specified agent configuration object.

Type

Agent configuration function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_AddAgentConfigAssociation (
   void*                            pSessionHandle,
   const char*                      pszAgentConfigOid,
   Sm_PolicyApi_Association_t*      pstructAssociation,
   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.
pszAgentConfigOid	I	Unique identifier of the agent configuration object.
pstructAssociation	I	The name/value pair to add or modify in the agent configuration object.
bUpdate	I	If true, the object is being updated.

Returns

Sm_PolicyApi_Success. The operation was successful.
Sm_PolicyApi_Failure. Generalized failure.
Sm_PolicyApi_InvalidOid. The unique ID does not correspond to an agent configuration object.
Sm_PolicyApi_NoPrivilege. The caller does not have the privilege to add agent configuration object parameters.
Sm_PolicyApi_InvalidHandle. The session pointer is not valid.
Sm_PolicyApi_NoSession. The API user is not properly logged in.