Sm_PolicyApi_GetGroupOids()

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

Sm_PolicyApi_GetGroupOids()

Retrieves the object identifiers contained within a group object. The results of this function are returned in a structure referenced by ppStructObjects.

Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().

pszDomainOid is required by a rule group or response group. An agent group does not require a domain OID because it is not a domain-based object.

Note: At releases prior to SiteMinder v4.5, the functionality provided by Sm_PolicyApi_GetGroupOids() was provided by Sm_PolicyApi_GetGroupNames().

Type

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

Syntax

int SM_EXTERN Sm_PolicyApi_GetGroupOids (
   void*                   pSessionHandle,
   Sm_PolicyApi_Groups_t   dwGroup,
   const char*             pszGroupOid,
   const char*             pszDomainOid,
   Sm_PolicyApi_Oid_t**    ppStructObjects
);

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 group from which to retrieve object identifiers.
pszGroupOid	I	A null-terminated string containing the object identifier of a group of the type indicated by dwGroup.
pszDomainOid	I	A null-terminated string containing the object identifier of an existing domain. Required parameter for rule or response group.
ppStructObjects	O	A pointer to the address of an object structure.

Returns

Sm_PolicyApi_Success. The get was successful.
Sm_PolicyApi_Failure. The get was not successful or memory could not be allocated to Sm_PolicyApi_Oid_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 group OIDs.
Sm_PolicyApi_InvalidOid:
- The group OID was not found.
- The domain OID was not found (for a domain-based group).
Sm_PolicyApi_BadGroup. Parameter dwGroup is not the rule, response, or agent type.