ALM Site Administratation Client Type Library
SetUserProperty Method
UserName
The user name.

PropertyNumber

The property number you wish to change. You can use the following constants or their values:

  • SA_USER_FULL_NAME (value: 3)
  • SA_USER_EMAIL (value: 4)
  • SA_USER_PHONE_NUMBER (value: 5)
  • SA_USER_DESCRIPTION (value: 6)
  • SA_USER_PASSWORD (value: 7)
  • SA_USER_DOM_AUTH (value: 8)
  • SA_USER_REPORT_ROLE (value: 9)

PropertyValue

The property value. If you are setting the user password, it will automatically be encrypted and sent to the server.

When you get the password back from the server, in GetUser for example, you will see the encrypted value.

Description

Sets a specific user property and retrieves the user properties.

Syntax

Visual Basic
Public Function SetUserProperty( _
   ByVal UserName As String, _
   ByVal PropertyNumber As Long, _
   ByVal PropertyValue As String _
) As String

Parameters

UserName
The user name.

PropertyNumber

The property number you wish to change. You can use the following constants or their values:

  • SA_USER_FULL_NAME (value: 3)
  • SA_USER_EMAIL (value: 4)
  • SA_USER_PHONE_NUMBER (value: 5)
  • SA_USER_DESCRIPTION (value: 6)
  • SA_USER_PASSWORD (value: 7)
  • SA_USER_DOM_AUTH (value: 8)
  • SA_USER_REPORT_ROLE (value: 9)

PropertyValue

The property value. If you are setting the user password, it will automatically be encrypted and sent to the server.

When you get the password back from the server, in GetUser for example, you will see the encrypted value.

Return Type

On success, returns an XML string containing the user properties.

Example

See Also

Send documentation feedback to HP.