Sm_PolicyApi_GetAgentConfigByName()

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

Sm_PolicyApi_GetAgentConfigByName()

Retrieves an existing agent configuration object by pszAgentConfigName.

Type

Agent configuration function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetAgentConfigByName (

   void*                            pSessionHandle,
   const char*                      pszAgentConfigName,
   Sm_PolicyApi_AgentConfig_t**     ppstructAgentConfig
);

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.
pszAgentConfigName	I	Unique name of the agent configuration object to retrieve.
ppstructAgentConfig	O	Address of a pointer to a structure that defines the agent configuration object. The function allocates the structure.

Returns

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

Email CA about this topic