<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css">
<title>
Gambas Documentation - Predefined Constants
</title>
</head>
<table class="none" width="100%" cellpadding="0" cellspacing="0" border="0">
<tr><td align="left">
<font size="-1">
<a href="../../help+en"><img class="flag" alt="Home" border="0" src="../../img/lang/en.png" align="center"></a>&nbsp;
<a href="../cat+en">Up</a>&nbsp;
<a href="char+en">Previous</a>&nbsp;
<a href="constants+en">Next</a>&nbsp;
</td></tr></table>
<div class="notab">
<h1>
Predefined Constants
</h1>
<h2>Datatypes</h2>
<p>
These constants are returned by <a href="../lang/typeof+en">TypeOf</a>.
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/null+en">gb.Null</a>
</td><td valign="top">
<a href="../lang/null+en">NULL</a> value
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/boolean+en">gb.Boolean</a>
</td><td valign="top">
<a href="../lang/type/boolean+en">Boolean</a> value
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/byte+en">gb.Byte</a>
</td><td valign="top">
<a href="../lang/type/byte+en">Byte</a> value
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/short+en">gb.Short</a>
</td><td valign="top">
<a href="../lang/type/short+en">Short</a> value
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/integer+en">gb.Integer</a>
</td><td valign="top">
<a href="../lang/type/integer+en">Integer</a> value
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/long+en">gb.Long</a>
</td><td valign="top">
<a href="../lang/type/long+en">Long</a> value
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/single+en">gb.Single</a>
</td><td valign="top">
<a href="../lang/type/single+en">Single</a> value
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/float+en">gb.Float</a>
</td><td valign="top">
<a href="../lang/type/float+en">Float</a> value
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/date+en">gb.Date</a>
</td><td valign="top">
<a href="../lang/date+en">Date</a> value
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/string+en">gb.String</a>
</td><td valign="top">
<a href="../comp/gb/string+en">String</a> value
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/variant+en">gb.Variant</a>
</td><td valign="top">
<a href="../lang/type/variant+en">Variant</a> value
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/object+en">gb.Object</a>
</td><td valign="top">
<a href="../comp/gb/object+en">Object</a> reference
</td></tr>
</table>
<p>

<h2>File types</h2>
<p>
These constants are used by the <a href="../lang/stat+en">Stat</a>() function.
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/file+en">gb.File</a>
</td><td valign="top">
Regular file
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/directory+en">gb.Directory</a>
</td><td valign="top">
Directory
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/device+en">gb.Device</a>
</td><td valign="top">
Special file for a device
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/pipe+en">gb.Pipe</a>
</td><td valign="top">
Named pipe
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/socket+en">gb.Socket</a>
</td><td valign="top">
Special file for a socket
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/link+en">gb.Link</a>
</td><td valign="top">
Symbolic link
</td></tr>
</table>
<p>
<h2>String constants</h2>
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/newline+en">gb.NewLine</a>
</td><td valign="top">
Newline character. Equivalent to <tt><a href="../lang/chr+en">Chr$</a>(10)</tt>.
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/tab+en">gb.Tab</a>
</td><td valign="top">
Tab character. Equivalent to <tt><a href="../lang/chr+en">Chr$</a>(9)</tt>.
</td></tr>
</table>
<p>
<h2>Sort types</h2>
<p>
These constants are used each time a sort method is needed.
For example, in the <a href="../comp/gb/array+en">Array</a> sort methods, when creating a <a href="../comp/gb/collection+en">Collection</a>,
in the <a href="../comp/gb/string+en">String</a> class methods, and so on.
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/binary+en">gb.Binary</a>
</td><td valign="top">
Binary sort.
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/text+en">gb.Text</a>
</td><td valign="top">
Case insensitive sort .
</td></tr>
</table>
<p>
<h2>Week days</h2>
<p>
These constant are the values returned by the <a href="../lang/weekday+en">WeekDay</a>() function.
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/monday+en">gb.Monday</a>
</td><td valign="top">
Monday
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/tuesday+en">gb.Tuesday</a>
</td><td valign="top">
Tuesday
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/wednesday+en">gb.Wednesday</a>
</td><td valign="top">
Wednesday
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/thursday+en">gb.Thursday</a>
</td><td valign="top">
Thursday
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/friday+en">gb.Friday</a>
</td><td valign="top">
Friday
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/saturday+en">gb.Saturday</a>
</td><td valign="top">
Saturday
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/sunday+en">gb.Sunday</a>
</td><td valign="top">
Sunday
</td></tr>
</table>
<p>
<h2>Predefined formats</h2>
<p>
<h3>Numeric formats</h3>
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/generalnumber+en">gb.GeneralNumber</a>
</td><td valign="top">
Write a number with twelve decimal digits.
Use scientific format if its absolute value is lower than 10<sup>-4</sup> or greater than 10<sup>7</sup>.
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/fixed+en">gb.Fixed</a>
</td><td valign="top">
Equivalent to <tt>&quot;0.00&quot;</tt>
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/percent+en">gb.Percent</a>
</td><td valign="top">
Equivalent to <tt>&quot;###%&quot;</tt>
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/scientific+en">gb.Scientific</a>
</td><td valign="top">
Write a number with its exponent and eighteen decimal digits.
</td></tr>
</table>
<p>
<h3>Date and time formats</h3>
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/generaldate+en">gb.GeneralDate</a>
</td><td valign="top">
Write a date only if the date and time value has a date part, and write a time only if it has a date part.
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/longdate+en">gb.LongDate</a>
</td><td valign="top">
Long date format.
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/mediumdate+en">gb.MediumDate</a>
</td><td valign="top">
Medium date format.
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/shortdate+en">gb.ShortDate</a>
</td><td valign="top">
Short date format.
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/longtime+en">gb.LongTime</a>
</td><td valign="top">
Long time format.
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/mediumtime+en">gb.MediumTime</a>
</td><td valign="top">
Medium time format.
</td></tr>
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/shorttime+en">gb.ShortTime</a>
</td><td valign="top">
<a href="../lang/type/short+en">Short</a> time format.
</td></tr>
</table>
<p>
<h3>Currency formats</h3>
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/currency+en">gb.Currency</a>
</td><td valign="top">
Format a currency by using the national currency symbol.
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/international+en">gb.International</a>
</td><td valign="top">
Format a currency by using the international currency symbol.
</td></tr>
</table>
<p>
<h3>Miscellaneous formats</h3>
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/standard+en">gb.Standard</a>
</td><td valign="top">
Use <a href="../comp/gb/gb/generalnumber+en">gb.GeneralNumber</a> for formatting numbers and
<a href="../comp/gb/gb/generaldate+en">gb.GeneralDate</a> for formatting dates and times.
</td></tr>
</table>
<p>
<h2>Endianness</h2>
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr class="dark"><td valign="top">
<a href="../comp/gb/gb/bigendian+en">gb.BigEndian</a>
</td><td valign="top">
Big endianness. The values are stored in memory the higher bytes first.
</td></tr>
<tr><td valign="top">
<a href="../comp/gb/gb/littleendian+en">gb.LittleEndian</a>
</td><td valign="top">
Little endianness. The values are stored in memory the lower bytes first.
</td></tr>
</table>

</div>
</body>
</html>

