Cadcorp SIS API Methods

GetStr Method

Description

Gets the value of a string property.

Syntax

Visual Basic
Public Function GetStr( _
   ByVal objectType As Integer, _
   ByVal nObject As Long, _
   ByVal propertyName As String _
) As String

Parameters

objectType
 
SIS_OT_COMMAND Changes the properties/mode of the current command.
SIS_OT_CURITEM The current open Item.
SIS_OT_DEFITEM The default Item.
SIS_OT_DATASET Datasets.
SIS_OT_OVERLAY Overlays.
SIS_OT_WINDOW The window.
SIS_OT_NOL Named Object Libraries.
SIS_OT_FTABLE The current Feature Table.
SIS_OT_SCHEMA The current Schema.
SIS_OT_SCHEMACOLUMN A column in the current Schema.
SIS_OT_THEME The current Theme.
SIS_OT_THEMECOMPONENT A component in the current Theme.
SIS_OT_PRINTER Printer.
SIS_OT_SYSTEM System variables.
SIS_OT_OPTION System wide Boolean options.
 
nObject
The index of the object type.
 
propertyName
The name of the property. All string properties end in '$'. The special properties "_properties$" and "_properties_edit$" are used to get lists of available properties for querying and editing respectively.

Return Type

The string value of the given property.

Remarks

Available: GEO MM ME MD OD OM OV SISpy

Group:

Example

Sis.GetStr(SIS_OT_SYSTEM,0,"_properties$")- will list all of the system options

Sis.GetStr(SIS_OT_OPTION,0,"_properties$")- will list all of the system variables


Send comments on this topic.

Click to return to www.cadcorp.com

© Copyright 2000-2017 Computer Aided Development Corporation Limited (Cadcorp).