All Cadcorp SIS API Methods

GetProfileStr Method

Description

Gets the value of a string profile property.

Note: Profile properties are held in the options database (these properties are for Application/Add-In use only).

Syntax

Visual Basic 
Public Function GetProfileStr( _
   ByVal propertyName As String, _
   ByVal defaultValue As String _
) As String

Parameters

propertyName
The name of the property. All string properties end in '$'.
 
defaultValue
If a value has not been assigned to the property the default value of the string will be returned.

Remarks

Available: GEO D OD OM OV SISpy

Note: In the case of SISpy, profile settings are only valid for as long as the SISpy module is loaded with no settings being saved between sessions. This is also the case for the SIS ActiveX Control unless the _OptionsDatabase$ system property has been set."

Group:

Example

SIS.GetProfileStr("SISGazetteer::ViewScaleMetres$", "200")

As "SISGazetteer::ViewScaleMetres$" has not been set, the above evaluation will return “200”.