Programming Guides › Programming Guide for C › Policy Management API › Function Declarations for the Policy Management API › Sm_PolicyApi_GetAgentTypeAttr()
Sm_PolicyApi_GetAgentTypeAttr()
Returns one or all agent attributes:
- If pszOid is of type Sm_PolicyApi_AgentType_Prop, the function returns all agent attributes.
- If pszOid is of type Sm_PolicyApi_AgentTypeAttr_Prop, the function returns an agent type attribute object.
Type
Agent function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetAgentTypeAttr (
void* pSessionHandle,
const char* pszOid,
Sm_PolicyApi_AgentTypeAttr_t** ppstructAgentTypeAttr
);
|
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.
|
|
pszOid
|
I
|
A null-terminated string containing the object identifier of an existing agent type or agent type attribute.
|
|
ppstructAgentTypeAttr
|
O
|
The address of a pointer to an agent type attribute structure.
|
Returns
- Sm_PolicyApi_Success. The get operation was successful.
- Sm_PolicyApi_Failure. Memory could not be allocated for Sm_PolicyApi_AgentTypeAttr_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 get an agent type or an agent type attribute.
- Sm_PolicyApi_InvalidOid. An agent type or an agent type attribute with the specified OID was not found.
