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     Methods
Level 2     ChangeGroup
Level 2     Login
Level 2     Logout
Level 2     PasswordModify
Level 2     Properties
Level 2     bAddGroups
Level 2     bAddItems
Level 2     bAddUsers
Level 2     bIsAdmin
Level 2     bNetworkLogin
Level 2     hSctx
Level 2     sCurrentGroup
Level 2     sServerName
Level 2     sSystemName
Level 2     sUserName
Level 2 mezObject
Level 2 mezProperty
Level 2 mezList
Level 2 mezUtility
Level 1 Enumeration Constants
Level 1 Status Codes
Level 1 General Information
   

ChangeGroup Method

This method changes the user's current group assignment. The status code integer result of the call to this method indicates whether the user's group assignment was successfully changed.

Syntax
objMezSession.ChangeGroup(
    ByVal sNewGroupName As String) As Integer

Parameters
    sNewGroupName
— the new group name to assign as the user's current group

Applies to
mezSession object

Return Value
Status Code (Integer)

 

Login Method

This method initiates a user session into a Content Services library. The status code integer result of the call to this method indicates whether the user session was successfully initiated.

Syntax
objMezSession.Login(
    ByVal sUserName As String,
    ByVal sPassword As String,
    ByVal sSystem As String,
    ByVal sServer As String,
    Optional ByVal sTemporaryFilePath As String = "",
    Optional ByVal bLogSQL As Boolean = False,
    Optional ByVal bLogMAPI As Boolean = False,
    Optional ByVal bLogCSAPI As Boolean = False,
    Optional ByVal sLogFileName As String = "",
    Optional ByVal bUseNetworkName As Boolean = False) As Integer

Parameters
    sUserName — the user's name
    sPassword — the user's password
    sSystem — the name of the CS library for the session
    sServer — the name of the server where the CS library is located
    sTemporaryFilePath — (optional) a location for temporary files created during session initiation;
        when a location is not specified, the directory assigned to the TEMP or TMP environment
        variable is used
    bLogSQL — (optional) indicates whether SQL logging will be enabled for the session;
        corresponds to the selection of "Log SQL Activities" in CS Explorer
    bLogMAPI — (optional) indicates whether CS Server API logging will be enabled for the session;
        corresponds to the selection of "Log Document Services Activities" in CS Explorer
    bLogCSAPI — (optional) indicates whether CS Admin Tools API logging will be enabled for the
        session; corresponds to the selection of "Log Admin Tools Activities" in CS Explorer
    sLogFileName — (optional) when logging is enabled, this is the full path for the log file;
        for example: "C:\Project\Explorer\admin.log"
    bUseNetworkName — (optional) indicates whether the session should be initiated from the
        user's network login

Applies to
mezSession object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.Form_Load

 

Logout Method

This method ends a user's session in a Content Services library. The status code integer result of the call to this method indicates whether the user session was terminated without error.

Syntax
objMezSession.Logout() As Integer

Parameters
None

Applies to
mezSession object

Return Value
Status Code (Integer)

Example
/SampleApps/UserGroupAdmin/frmMain.Form_Unload

 

PasswordModify Method

This method can be used to change a user's password. The status code integer result of the call to this method indicates whether the user's password was successfully changed.

Syntax
objMezSession.PasswordModify(
    ByVal sOldPassword As String,
    ByVal sNewPassword As String) As Integer

Parameters
    sOldPassword
— the current password for the user
    sNewPassword — the new password to assign for the user

Applies to
mezSession object

Return Value
Status Code (Integer)