Sm_PolicyApi_IsGroup()

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

Sm_PolicyApi_IsGroup()

Determines whether an item is a group.

Type

Group function, global scope (agents) or domain scope (responses, rules).

Syntax

int SM_EXTERN Sm_PolicyApi_IsGroup (
   void*                   pSessionHandle,
   Sm_PolicyApi_Groups_t   dwGroup,
   const char*             pszOid,
   const char*             pszDomainOid,
   bool*                   bIsGroup
);

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.
dwGroup	I	Indicates the type of the object.
pszOid	I	A null-terminated string containing the object identifier of the item to check.
pszDomainOid	I	A null-terminated string containing the object identifier of an existing domain.
bIsGroup	O	A pointer to a boolean value. true if the pszOid object is a group.

Returns

Sm_PolicyApi_Success. The OID is a group.
Sm_PolicyApi_Failure. The OID is not a group.
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 find out if a rule, response, or agent OID is a group.
Sm_PolicyApi_InvalidOid:
- The domain OID was not found (for a domain-based group).
- The group OID was not found.
- The rule, response, or agent OID or group OID was not found.
Sm_PolicyApi_BadGroup. Parameter dwGroup is not the rule, response, or agent type.