IGlobalVariables.SetVariable Method

Sets or creates a variable with specified details.
Function SetVariable( _ 
ByVal variableInfo As GlobalVariableInfo
) As Boolean
This language is not supported or no code example is available.
bool SetVariable( 
GlobalVariableInfo variableInfo 
)
This language is not supported or no code example is available.

Parameters

variableInfo
GlobalVariableInfo

The new properties of the variable.

Return Value

bool

A value indicating whether the variable was really changed or created. false if no change was done, i.e. the variable already existed and its value, type and access were the same as in variableInfo.

Exception type Condition

QdvApiException

A problem occurred.

Remarks
 

This method creates a new variable if it doesn't exist yet.

The variables belong to several categories. Each category is identified with a 4 characters long prefix. There are some restrictions for some categories.

The variables with the 'SYS_' prefix cannot be created or deleted. You cannot change their access permission and their data type. You can only modify their value. Different values for the type and access will be ignored.

The variables with the 'GLV_' prefix can have only the read-write access. Different values for the access will be ignored.

Version
 
Available since QDV 7.13.0001.

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

In this article

Definition