ValueStringGet

Note: This page includes content based on the F1 documentation for Centura development. It may be partially converted to support APF development, but should be regarded to be of uncertain actuality. It is provided as is. Eventually, it should be replaced by documentation available from within Visual Studio.

SalNumber ValueStringGet( SalString sSection,
		       SalString sEntry,
		       SalString sDefault,
		       ref SalString sValue )

The ValueStringGet method reads a string value from the personal or default profile.

Parameters

Name Description
SalString sSection Name of section from which to read the value. The section name is combined with the entry name to form a unique key for the value to be written.
SalString sEntry Name of entry to read in the specified section.
SalString sDefault Value that will be returned in sValue if the specified entry and section does not exist.
ref SalString sValue Value of the specified entry read from the profile.

Returns

The return value is the string length of sValue.

Comments

The ValueStringGet method always checks the personal profile first. If the specified section and entry do not exist in the personal profile, the default profile is used instead. If the specified section and entry doesn't exist in either profile, the sDefault value is returned.

Example

Call Profile.ValueStringGet ( sProfileSection,
              'EnterToTab', sDefault, sValue )
Call _MDIMapEnterToTabSet( ( sValue = 'TRUE' ) )
C# code
Var.Profile.ValueStringGet(sProfileSection, "DesignTimeOrderBy", "TRUE", ref sValue);