Sm_PolicyApi_GetRealmByName()

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

Sm_PolicyApi_GetRealmByName()

Gets the contents of the realm identified by pszRealmName, and the corresponding pszDomainOrParentRealmOid of the Domain in which the Realm exists, or the Oid of the Parent Realm in the case of a child Realm.

The results of this function are returned in a structure referenced by ppstructRealm. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().

Type

Realm function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetRealmByName (
   void*                    pSessionHandle,
   const char*              pszRealmOid, 
   Sm_PolicyApi_Realm_t**   ppstructRealm
);

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.
szDomainOr ParentRealm Oid	I	A null-terminated string containing the object identifier of an existing Domain or Realm
pszRealmName	I	A null-terminated string containing the name of an existing realm.
ppstructRealm	O	The address of a pointer to a realm structure.

Returns

Sm_PolicyApi_Success. The get operation was successful.
Sm_PolicyApi_Failure. Memory could not be allocated for Sm_PolicyApi_Realm_t.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get a realm.
Sm_PolicyApi_InvalidOid. The Domain or parent Realm OID was not found.
Sm_PolicyApi_NotFound The Realm name was not found.