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 mezProperty
Level 2     Methods
Level 2     AddChild
Level 2     ConvertIndexed
Level 2     Expand
Level 2     GetActionListItem
Level 2     GetValueList
Level 2     GetValueListItem
Level 2     NewChild
Level 2     RemoveChild
Level 2     SetPropertyData
Level 2     Validate
Level 2     Properties
Level 2     bDisplayInPropSheet
Level 2     bDisplayInTree
Level 2     bHasValueList
Level 2     bIsAddableFromNewParent
Level 2     bIsDataVisible
Level 2     bIsExpandable
Level 2     bIsIndexed
Level 2     bIsKeyPart
Level 2     bIsModifiable
Level 2     bIsModified
Level 2     bIsRequired
Level 2     bMustPick
Level 2     bValueListMoreAvailable
Level 2     eParentAccessLevel
Level 2     ePropertyDataType
Level 2     ePropertyType
Level 2     eSortType
Level 2     hSctxHndl
Level 2     iActionListCount
Level 2     iParentObjectNumber
Level 2     iPropertyLength
Level 2     iPropertyNum
Level 2     iPropertyRefAttr
Level 2     iRefObjectNum
Level 2     lValueListCount
Level 2     mzList
Level 2     sParentKeyValue
Level 2     sPropertyData
Level 2     sPropertyName
Level 2 mezList
Level 2 mezUtility
Level 1 Enumeration Constants
Level 1 Status Codes
Level 1 General Information
   

AddChild Method

This method adds a new child mezObject (created by calling NewChild()) to the mezProperty object's mzList property collection (mezList object). The status code integer result of the call to this method indicates whether the new child mezObject was successfully added.

Syntax
objMezProperty.AddChild(
    ByVal mzoChildObject As mezObject) As Integer

Parameters
    mzoChildObject
— the new mezObject to add as a child to the mezProperty object's mzList

Applies to
mezProperty object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/ctlPickList.cmdAdd_Click

See Also
mzList Property
NewChild Method
mezList Object
mezObject Object

 

ConvertIndexed Method

When the bIndexed property of a mezProperty object is set to Boolean True, this method can be used to convert an integer value property into a string, and vice-versa. After the conversion, the converted value is available by reference via the function parameters (see the description below). The status code integer result of the call to this method indicates whether the property value was successfully converted.

Syntax
objMezProperty.ConvertIndexed(
    ByRef sStringVal As String,
    ByRef iIntegerValue As Integer) As Integer

Parameters

    a) ConvertIndexed ( string_to_convert, integer_result )
    b) ConvertIndexed ( string_result, integer_to_convert )

    sStringVal   a) passed sStringVal value is non-empty
                              convert sStringVal to integer and store result in iIntegerValue
                          b) passed sStringVal value is empty
                              convert iIntegerValue to string and store result in sStringVal
    iIntegerVal  a) passed iIntegerValue value is non-empty
                              convert iIntegerValue to string and store result in sStringVal
                          b) passed iIntegerValue value is empty
                              convert sStringVal to numeric and store result in iIntegerValue

Applies to
mezProperty object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/ctlPicklist.cmdAdd_Click

See Also
bIsIndexed Property

 

Expand Method

This method may only be used for list type mezProperty objects, and is used to generate the property's mzList property collection (mezList) and populate it with child mezObjects. The mezList object provides methods that enable access to the mezObjects contained in the mezList. The status code integer result of the call to this method indicates whether the list of children was successfully expanded.

Syntax
objMezProperty.Expand(
    ByVal lMaxChildren As Long,
    Optional ByVal sStartKey As String = "",
    Optional ByVal bScrollForward As Boolean = True) As Integer

Parameters
    lMaxChildren
— the maximum number of child mezObjects to retrieve
    sStartKey — (optional) the starting value from which to begin expanding the list,
        starts at the beginning when not specified
    bScrollForward — (optional) when set to Boolean True, scrolls forward in the list from the value
        specified in sStartKey; otherwise, scrolls backward from the value in sStartKey

Applies to
mezProperty object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.AddNode

See Also
mzList Property
mezObject sListKey Property
mezList Object
mezObject Object

 

GetActionListItem Method

This method returns an individual action item from the mezProperty object's action list.

NOTE: Although any of the e_Actions enumerations may be specified for a mezProperty object, the only action that will ever be performed is eActionAdd (add an object or property of this type). In addition, even when the user has add permission for the Access List, Group Membership, or Default Item Access List properties, nothing is returned by this method. This is due to the manner in which users, groups, and access list objects are added in CS Explorer. For more information about action lists, see the FileNet Content Services API Manual, release 5 series documentation on the FileNet website.

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

Parameters
    iIndex
— the index into the action list

Applies to
mezProperty object

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

eActionAdd — add an object or property of this type
eActionCopy — (not valid for mezProperty objects) copy this object
eActionDelete — (not valid for mezProperty objects) delete this object
eActionRename — (not valid for mezProperty objects) rename this object

See Also
e_Actions Enumeration

 

GetValueList Method

This method initializes the mezProperty object's value list. The status code integer result of the call to this method indicates whether the mezProperty object was initialized successfully.

Syntax
objMezProperty.GetValueList(
    ByVal lMaxRows As Long,
    Optional sStartValue As String = "",
    Optional sListAllUsersGroups As String = "",
    Optional ByVal bScrollForward As Boolean = True) As Integer

Parameters
    lMaxRows
— the maximum number of rows to retrieve
    sStartValue — (optional) the starting value for initializing the list,
        starts at the beginning when not specified
    sListAllUsersGroups — (optional) This parameter is only valid for properties of type
        SPI_GRPMEM_GROUP, SPI_GRPMEM_USER, SPI_AC_NAME, or SPI_DEFACL_HOLDER_NAME.
        The possible values for this parameter include, "U" for users, "G" for groups, or empty.
        When the parameter is set to "U" or "G", the function will retrieve all of the users or
        groups from the CS library, respectively.
    bScrollForward — (optional) when set to Boolean True, scrolls forward in the list from the
        value specified in sStartValue; otherwise, scrolls backward from the value in sStartValue

Applies to
mezProperty object

Return Value
Status Code (Integer)

Example
/SampleApps/Users/frmAccess.opGroups_Click

See Also
bHasValueList Property
bIsIndexed Property
bMustPick Property
bValueListMoreAvailable Property
GetValueListItem Method

 

GetValueListItem Method

This method retrieves possible values for a single value type mezProperty object. This set is normally displayed using a drop down list or similar control in the user interface. The user chooses one value from the supplied list to apply to the property. The status code integer result of the call to this method indicates whether the set of values was successfully retrieved.

Syntax
objMezProperty.GetValueListItem(
    ByVal lIndex As Long) As Integer

Parameters
    lIndex
— the index of the value to retrieve from the mzlist

Applies to
mezProperty object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/ctlPropertyList.BuildPropertyList

See Also
mzList Property
bHasValueList Property
bIsIndexed Property
bMustPick Property
bValueListMoreAvailable Property
GetValueList Method
mezList Object

 

NewChild Method

This method creates a new child mezObject for the mezProperty object without adding the child to the property's mzList property collection. The child can be added later by calling AddChild(). The status code integer result of the call to this method indicates whether the new child mezObject was successfully created.

Syntax
objMezProperty.NewChild(
    ByRef mzoNewChild As mezObject) As Integer

Parameters
    mzoNewChild
— the new child mezObject, created by the function

Applies to
mezProperty object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.cmbAction_Click

See Also
mzList Property
AddChild Method
mezObject Object

 

RemoveChild Method

This method removes a child mezObject from a mezProperty object's mezList object (contained in the mzList property). The method can only be used for mezObjects that have an e_ObjectState enumeration value of either eObjStateNew or eObjStateDeleted. The status code integer result of the call to this method indicates whether the child mezObject was successfully removed.

Syntax
objMezProperty.RemoveChild(
    ByRef mzoChildObject As mezObject) As Integer

Parameters
    mzoChildObject
— the child mezObject to remove from the property object

Applies to
mezProperty object

Return Value
Status Code (Integer)

See Also
mzList Property
mezList Object
mezObject Object
e_ObjectState Enumeration

 

SetPropertyData Method

This method is only valid for single value mezProperty objects, and is used to apply a new data value to a property. The status code integer result of the call to this method indicates whether the property value was successfully changed.

Syntax
objMezProperty.SetPropertyData(
    ByVal sNewValue As String) As Integer

Parameters
    sNewValue
— the new data value for the property

Applies to
mezProperty object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/ctlPropertyList.UpdateProperty

 

Validate Method

This method validates a specified or current value for a mezProperty object. The status code integer result of the call to this method indicates whether the verification was successfully performed.

Syntax
objMezProperty.Validate(
    Optional ByVal sValue As String = "") As Integer

Parameters
    sValue
— (optional) when non-empty, the specified value is verified to ensure that it is an
        appropriate value to assign to property. When sValue is empty, the current value of the
        property is verified. The following criteria are analyzed during the verification process:
        • value is the correct data type for the property object
        value is within the range of possible values for the property object
        when bMustPick property is set to True, value is in property object's value list

Applies to
mezProperty object

Return Value
Status Code (Integer)

See Also
bMustPick Property