Difference between revisions of "SHIPHarbour:XVars:Type"

From Serious Documentation
Jump to: navigation, search
(Description)
 
Line 1: Line 1:
 
== Description ==
 
== Description ==
 
<onlyinclude>Used in [[SHIPHarbour:XVars|XVar]] requests to strictly define the type of data being transmitted and received.</onlyinclude>
 
<onlyinclude>Used in [[SHIPHarbour:XVars|XVar]] requests to strictly define the type of data being transmitted and received.</onlyinclude>
 +
 +
== Values ==
 +
 +
=== UNSET_TYPE ===
 +
Must not be used, indicates the field was not set properly.
 +
 +
=== INVALID_TYPE ===
 +
May be used internally to indicate an error when encountering an unexpected value.
 +
 +
=== BOOL ===
 +
A boolean value indicating true or false.
 +
 +
=== SINT08 ===
 +
A signed 8-bit integer value.
 +
 +
=== SINT16 ===
 +
A signed 16-bit integer value.
 +
 +
=== SINT32 ===
 +
A signed 32-bit integer value.
 +
 +
=== SINT64 ===
 +
A signed 64-bit integer value.
 +
 +
=== FLOAT ===
 +
A 32-bit floating point value.
 +
 +
=== DOUBLE ===
 +
A 64-bit floating point value.
 +
 +
=== STRING ===
 +
A series of UTF-8/7-bit ASCII values.
 +
 +
=== BYTES ===
 +
A series of unsigned 8-bit values.

Latest revision as of 17:04, 31 July 2017

Description

Used in XVar requests to strictly define the type of data being transmitted and received.

Values

UNSET_TYPE

Must not be used, indicates the field was not set properly.

INVALID_TYPE

May be used internally to indicate an error when encountering an unexpected value.

BOOL

A boolean value indicating true or false.

SINT08

A signed 8-bit integer value.

SINT16

A signed 16-bit integer value.

SINT32

A signed 32-bit integer value.

SINT64

A signed 64-bit integer value.

FLOAT

A 32-bit floating point value.

DOUBLE

A 64-bit floating point value.

STRING

A series of UTF-8/7-bit ASCII values.

BYTES

A series of unsigned 8-bit values.