EsbRenameUser

Renames an existing user.

Syntax

EsbRenameUser (hCtx, UserName, nUserName)
ByVal hCtx      As Long
ByVal UserName  As String
ByVal nUserName As String
ParameterDescription

hCtx

VB API context handle.

UserName

Old name of an existing user to rename.

nUserName

New name for the renamed user. See User Name Limits.

Notes

The specified new user name must not already exist.

Return Value

None.

Access

This function requires the caller to have Create/Delete User privilege (ESB_PRIV_USERCREATE) for the logged in server.

Example

Declare Function EsbRenameUser Lib "ESBAPIN" (ByVal hCtx As Long, ByVal OldName As String, ByVal NewName As String) As Long

Sub ESB_RenameUser ()
   Dim sts As Long
   Dim OldName As String
   Dim NewName As String   OldName = "Joseph"
   NewName = "Joe"   '************
   ' Rename user
   '************
   sts = EsbRenameUser (hCtx, OldName, NewName) 
End Sub

See Also