GetFldType.md

GetFldType

Description

Returns a constant indicating the data type of a specified field in the referenced record.

Please refer to the [[VS:Function Reference Appendix#Record - Worksheet Field Types |VectorScript Appendix]] for specific field data types and formatting.

For Plug-in Object Parameter Records, the field types are documented in the [[VS:Function Reference Appendix#Plug-in Object Parameter Record Field Types|VectorScript Appendix]].

FUNCTION GetFldType(
				h : HANDLE;
				t : INTEGER): INTEGER;

def vs.GetFldType(h, t):
    return INTEGER

Parameters

Name	Type	Description
h	HANDLE	Handle to record.
t	INTEGER	Field index (range of 1 - n).

Remarks

Returns a constant indicating which type of field is specified by the field number "t" of record "h". The field type constants are listed in an appendix in the vectorscript manual.

In the appendix, the field types for worksheets and data records are listed, but the field types for parameter records (e.g., plug-in object records) are different...

Data Records:

{| class="wikitable"

! Constant !! Description
1
-
2
-
3
-
4
-
5
-
6
-
7
-
8
-
9
-
10
-
11
}

PIO Records:

{| class="wikitable"

! Constant !! Description
1
-
2
-
3
-
4
-
7
-
8
-
9
-
10
-
11
-
14
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
29
-
30
}

Examples

==== VectorScript ====

fieldType:=GetFldType(recordHandle,3);

==== Python ====

fieldType = vs.GetFldType(recordHandle,3)

Version

Availability: from All Versions

Category

• Database @ Record