Sm_PolicyApi_GetAgentConfigAssociations()

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

Sm_PolicyApi_GetAgentConfigAssociations()

Retrieves a list of configuration parameters for an agent configuration object.

Type

Agent configuration function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetAgentConfigAssociations (
   void*                           pSessionHandle,
   const char*                     pszAgentConfigOid,
   Sm_PolicyApi_Association_t**    ppstructAssociations
);

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.
ppstructAssociations	O	A list of name/value pairs representing the configuration parameters for the agent configuration object.

Returns

Sm_PolicyApi_Success. The get 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 retrieve configuration parameters for an agent configuration object.
Sm_PolicyApi_InvalidHandle. The session pointer is not valid.
Sm_PolicyApi_NoSession. The API user is not properly logged in.