ValueStringGetEx

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 ValueStringGetEx( SalString sSection,
		         SalString sEntry,
		         SalString sDefault,
		         SalNumber nProfile,
		         ref SalString sValue )

This is the extended version of the ValueStringGet method, beside the same functionality this method also return the profile origin of the value retrieved. Use the profile parameter to specify a specific profile to get the value from.

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.
SalNumber nProfile Specify from which profile the entry should be fetched Const.PROFILE_Default, Const.PROFILE_Personal or Const.PROFILE_Any. If Const.PROFILE_Any is specified the personal profile will be searched first.
ref SalString sValue Value of the specified entry read from the profile.

Returns

Unknown

Comments

Use this method where you need to know the origin of the fetched value. That may be useful in cases where the user should be able to update a value from the personal profile but not when retrieved from the default profile.