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 mezList
Level 2 mezUtility
Level 2     Methods
Level 2     DoesObjectExist
Level 2     GetGeneralUsersName
Level 2     GetMezObject
Level 2     GetMezProperty
Level 2     GetObjectAccess
Level 2     GetObjectName
Level 2     IsSystemCaseSensitive
Level 1 Enumeration Constants
Level 1 Status Codes
Level 1 General Information
   

DoesObjectExist Method

This method returns Boolean True when the identified object exists in the Content Services library being accessed by the current session; otherwise, the function returns false.

Syntax
objMezUtility.DoesObjectExist(
    
ByVal hSctx As Long,
    ByVal iObjectNo As Integer,
    ByVal sKey As String) As Boolean

Parameters
    hSctx
— the handle to the current session
    iObjectNo — the number of the object
    sKey — the key for the object

Applies to
mezUtility object

Return Value
Boolean

 

GetGeneralUsersName Method

This method retrieves the name of the General Users group. The status code integer result of the call to this method indicates whether the group name was successfully retrieved.

Syntax
objMezUtility.GetGeneralUsersName(
    ByVal hSctx As Long,
    ByRef sGeneralUsers As String) As Integer

Parameters
    hSctx
— the handle to the current session
    sGeneralUsers — (set by the method) the name of the General Users group

Applies to
mezUtility object

Return Value
Status Code (Integer)

 

GetMezObject Method

This method retrieves a specified mezObject from the Content Services library being accessed by the current session. The status code integer result of the call to this method indicates whether the object was successfully retrieved.

Syntax
objMezUtility.GetMezObject(
    ByVal hSctx As Long,
    ByVal iObjectNum As Integer,
    ByVal sKey As String,
    ByRef mzoObject As mezObject) As Integer

Parameters
    hSctx
— the handle to the current session
    iObjectNum — the number of the object
    sKey — the key for the object
    mzoObject — (set by the method) the mezObject

Applies to
mezUtility object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.ShowForm

See Also
mezObject Object

 

GetMezProperty Method

This method retrieves a specified mezProperty object from an existing mezObject in the Content Services library being accessed by the current session. The status code integer result of the call to this method indicates whether the property object was successfully retrieved.

Syntax
objMezUtility.GetMezProperty(
    ByVal hSctx As Long,
    ByVal iParentObjectNum As Integer,
    ByVal iPropertyNum As Integer,
    ByVal sParentKey As String,
    ByRef mzoProperty As mezProperty) As Integer

Parameters
    hSctx
— the handle to the current session
    iParentObjectNum — the number of the mezObject parent of the mezProperty
    iPropertyNum — the number of the mezProperty
    sParentKey — the key for the mezObject parent of the mezProperty
    mzoProperty — (set by the method) the mezProperty object

Applies to
mezUtility object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.DeleteObjectFromList

See Also
mezObject Object
mezProperty Object

 

GetObjectAccess Method

This method retrieves the access level that the user has to a mezObject in the Content Services library being accessed by the current session, as defined in the e_ObjectAccess enumeration. The status code integer result of the call to this method indicates whether the access level was successfully determined.

Syntax
objMezUtility.GetObjectAccess(
    ByVal hSctx As Long,
    ByVal iObjectNo As Integer,
    ByVal sKey As String,
    ByRef Access As e_ObjectAccess) As Integer

Parameters
    hSctx
— the handle to the current session
    iObjectNum — the number of the object
    sKey — the key for the object
    Access — (set by the method) the access level that the user has to an object in the CS library,
        as defined in the e_ObjectAccess enumeration:

    eObjAccessNone — no privileges to the object (not visible to end user)
    eObjAccessViewer — read-only
    eObjAccessAuthor — read and write, version check-in / out,
        modify certain properties
    eObjAccessOwner — all author privileges, create / delete object,
        modify most properties
    eObjAccessAdmin — all owner privileges, modify all modifiable properties

        For more information about security access rights for end users, see the
        FileNet Content Services API Manual, release 5 series documentation
        on the FileNet website.

Applies to
mezUtility object

Return Value
Status Code (Integer)

Example
/SampleApps/Users/frmMain.lstUsers_Click

See Also
e_ObjectAccess enumeration
mezObject Object

 

GetObjectName Method

This method retrieves the display name for the type of an existing mezObject in the Content Services library being accessed by the current session. This method corresponds to the spiObjectNameGet() function in the Content Services API. For more information about object names, see the FileNet Content Services API Manual, release 5 series documentation on the FileNet website. The status code integer result of the call to this method indicates whether the name was successfully retrieved.

Syntax
objMezUtility.GetObjectName(
    ByVal hSctx As Long,
    ByVal iObjectNumber As Integer,
    ByRef sObjectName As String) As Integer

Parameters
    hSctx
— the handle to the current session
    iObjectNumber — the number of the object
    sObjectName — (set by the method) the display name of the object type

Applies to
mezUtility object

Return Value
Status Code (Integer)

See Also
mezObject Object

 

IsSystemCaseSensitive Method

This method is used to determine if the name of the Content Services library being accessed by the current session is case sensitive; otherwise, the function returns false. The status code integer result of the call to this method indicates whether the CS library name was successfully queried.

Syntax
objMezUtility.IsSystemCaseSensitive(
    ByVal hSctx As Long,
    ByRef bCaseSensitive As Boolean) As Integer

Parameters
    hSctx
— the handle to the current session
    bCaseSensitive — (set by the method) indicates whether the CS library name is case sensitive

Applies to
mezUtility object

Return Value
Status Code (Integer)