Skip navigation  
Glossary  |  General Information  
   Content Services User Administration API
     Search in CS User Admin API Overview   |   API Classes   |   Enumeration Constants   |   Status Codes  
Level 1 Overview
Level 1 API Classes
Level 2 mezSession
Level 2 mezObject
Level 2     Methods
Level 2     Copy
Level 2     Delete
Level 2     GetActionListItem
Level 2     GetData
Level 2     GetPropertyByID
Level 2     GetPropertyByIndex
Level 2     RefreshData
Level 2     Rename
Level 2     SetDeleteFlag
Level 2     SetupNewObject
Level 2     Update
Level 2     Properties
Level 2     bAreRequiredPropertiesEntered
Level 2     bDeleteFlag
Level 2     bIsModifiable
Level 2     bIsModified
Level 2     eAccessLevel
Level 2     eObjectState
Level 2     hSctx
Level 2     iActionListCount
Level 2     iKeyCount
Level 2     iObjectNum
Level 2     iPropertyCount
Level 2     sKeyValue
Level 2     sListKey
Level 2     sObjectName
Level 2 mezProperty
Level 2 mezList
Level 2 mezUtility
Level 1 Enumeration Constants
Level 1 Status Codes
Level 1 General Information
   

Copy Method

This method returns a new mezObject, which is created by copying the current mezObject. The method may only be used for objects of type SPI_OBJ_USER or SPI_OBJ_GROUP. The status code integer result of the call to this method indicates whether the new mezObject was successfully created.

Syntax
objMezObject.Copy(
    ByRef mzoObject as mezObject) As Integer

Parameters
    mzoObject
— a reference to a new mezObject that will be the copy of the current object

Applies to
mezObject object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.cmbAction_Click

 

Delete Method

This method deletes a mezObject from a CS library. The status code integer result of the call to this method indicates whether the object was successfully deleted.

Syntax
objMezObject.Delete() As Integer

Parameters
None

Applies to
mezObject object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.cmbAction_Click

 

GetActionListItem Method

This method returns an individual action item for a mezObject.

Syntax
objMezObject.GetActionListItem(
    ByVal iIndex as Integer) As e_Actions

Parameters
    iIndex
— the index into the action list (within the range of 1 - mezObject.iActionListCount)

Applies to
mezObject object

Return Value
An e_Actions enumeration representing the possible actions the user can perform on the mezObject:

eActionAdd — (not valid for mezObjects) add an object of this type
eActionCopy — copy this object
eActionDelete — delete this object
eActionRename — rename this object

Example
/SampleApps/UserGroupAdmin/frmMain.Display_Actions

See Also
iActionListCount Property
e_Actions Enumeration

 

GetData Method

This method converts a mezObject from partial to full by populating all of the property values for the object. The status code integer result of the call to this method indicates whether the property values were successfully populated.

Syntax
objMezObject.GetData() As Integer

Parameters
None

Applies to
mezObject object

Return Value
Status Code (Integer)

 

GetPropertyByID Method

This method returns a mezProperty object that represents one of the properties of the mezObject. The property object is retrieved by passing the property identifier to the method. The status code integer result of the call to this method indicates whether the property object was successfully retrieved.

Syntax
objMezObject.GetPropertyByID(
    ByVal iPropertyID as Integer,
    ByRef mzoProperty as mezProperty) As Integer

Parameters
    iPropertyId
— the identifier of the property to retrieve
    mzoProperty — (set by the method) the mezProperty object

Applies to
mezObject object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.DisplayPropertyInListView

See Also
mezProperty Object

 

GetPropertyByIndex Method

This method returns a mezProperty object that represents one of the properties of the mezObject. The property object is retrieved by passing its associated index (ordinal value) contained in the object, to the method. The status code integer result of the call to this method indicates whether the property object was successfully retrieved.

Syntax
objMezObject.GetPropertyByIndex(
    ByVal iIndex as Integer,
    ByRef mzoProperty as mezProperty) As Integer

Parameters
    iIndex
— the identifier of the property to retrieve
    mzoProperty — (set by the method) the mezProperty object

Applies to
mezObject object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.BuildPropertyList

See Also
mezProperty Object

 

RefreshData Method

This method refreshes the properties of a mezObject from the server. The status code integer result of the call to this method indicates whether the refresh from the server was successful.

Syntax
objMezObject.RefreshData() As Integer

Parameters
None

Applies to
mezObject object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.cmbSave_Click

 

Rename Method

This method renames the mezObject using the string passed into the method. The method is only valid for objects of type SPI_OBJ_USER and SPI_OBJ_GROUP. The status code integer result of the call to this method indicates whether the object was successfully renamed.

Syntax
objMezObject.Rename(
    ByVal sNewName as String) As Integer

Parameters
    sNewName
— the new name to be applied to the mezObject

Applies to
mezObject object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.cmbAction_Click

 

SetDeleteFlag Method

This method sets the delete flag of the mezObject to either Boolean True or False. When a mezObject's delete flag is set to True, the mezObject is deleted the next time the Update() method is called. The status code integer result of the call to this method indicates whether the delete flag was successfully changed.

Syntax
objMezObject.SetDeleteFlag(
    ByVal bDelete As Boolean) As Integer

Parameters
    bDelete
— the new boolean value for the object's delete flag

Applies to
mezObject object

Return Value
Status Code (Integer)

Example
/SampleApps/Users/frmGroupMembership.UndoChanges

See Also
bDeleteFlag Property
Delete Method
Update Method

 

SetupNewObject Method

This method is used to obtain information about a particular type of mezObject. Note: When adding a new object to a CS library use the mezProperty.NewChild() method, rather than SetupNewObject(). The status code integer result of the call to this method indicates whether the new mezObject was successfully created.

Syntax
objMezObject.SetupNewObject(
    ByVal hSctx As Long,
    ByVal iObjectNumber As Integer) As Integer

Parameters
    hSctx
— the session handle to the new mezObject
    iObjectNumber — the object number for the new mezObject

Applies to
mezObject object

Return Value
Status Code (Integer)

Example
/SampleApps/Users/frmGroupMembership.DisplayAvailable

See Also
mezProperty NewChild Method
mezProperty Object

 

Update Method

This method stores the data contained in a mezObject to the server. The method also performs a cascading update of all child objects contained in the parent object's properties. When a hierarchy of objects is updated (for example, a User object along its' child Group Member and Access Control List objects), multiple errors may result. All error strings are captured and concatenated into the sErrInfo parameter, and are delimited using the line feed character. The status code integer result of the call to this method indicates whether the data was stored to the server successfully.

Syntax
objMezObject.Update(
    ByRef sErrInfo As String,
    ByRef iNumMsgs As Integer) As Integer

Parameters
    sErrInfo
— string of concatenated error messages resulting from the update, delimited by line feeds
    iNumMsgs — the number of error messages contained in sErrInfo

Applies to
mezObject object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.cmbSave_Click