SetUserParameter

Sets a parameter for the user. Use SetUserParameter to create and edit custom parameters for items such as personal preferences. These parameters are stored in the database and thus persist beyond the current session.

Tip:

GetUserParameter returns a user parameter and DeleteUserParameter deletes a user parameter. For details, see GetUserParameter and DeleteUserParameter.

Syntax

<HsvSystemInfo>.SetUserParameter bstrKey, varabyData

Argument

Description

bstrKey

String (ByVal). The key that identifies the parameter.

varabyData

Byte array (ByVal). The value to be set for the user parameter.

Example

The following example sets a user parameter named “Projects” to the value specified in the comboParams combo box.

Dim cHsvSystemInfo As HsvSystemInfo
'm_cHsvSession is an HsvSession object reference
Set cHsvSystemInfo = m_cHsvSession.SystemInfo
'Example assumes the combo box contains 1-character values.
Dim bytSetParam(0) As Byte
bytSetParam(0) = CByte(comboParams.Text)
cHsvSystemInfo.SetUserParameter "Projects", bytSetParam