SetUserSetting

Stores a specified setting with a tag that identifies it. Use SetUserSetting to add custom settings to an application.

To persist a setting past the current session, you must call ApplyUserSettings.

Note:

To get a setting, use GetUserSetting. To remove a setting, use RemoveUserSetting.

Syntax

<HFMwSession>.SetUserSetting bstrPOVTag, bstrPOV

Argument

Description

bstrPOVTag

A unique tag that identifies the setting.

Input argument. String subtype.

bstrPOV

The setting’s value.

Input argument. String subtype.

Example

The following subroutine sets and persists the specified setting.

Sub SetCustomProperty(sTag, sValue)
' cHFMSession is a previously set HFMwSession object reference
cHFMSession.SetUserSetting sTag, sValue
cHFMSession.applyUserSettings FALSE
End Sub