All Cadcorp SIS API Methods

GetCursorFieldDescription Method

Description

Get the description of the specified field from a specified cursor.

Syntax

Public Function GetCursorFieldDescription( _
   ByVal cursor As String, _
   ByVal nField As Long _
) As String

Parameters

cursor

The name of the cursor to be interrogated.

 

nField

The index number of the field we are interrogating, the index starts at 0.
Use nField = -1 to get all of the column descriptions.

Return Type

The field’s description as a string.

Remarks

Available: GEO D OD OM SISpy

Group:

• Named Cursor Methods

Example

sis.GetCursorFieldDescription ("MyCursor", 0)