<!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 - Method &amp; Property Signatures
</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="returnstring+en">Previous</a>&nbsp;
<a href="special+en">Next</a>&nbsp;
</td></tr></table>
<div class="notab">
<h1>
Method &amp; Property Signatures
</h1>
A signature is a concatenation of one or more datatype string representation.
<p>
Here is the different possible string representations:
<p>
<table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0">
<tr><th>
Type
</th><th>
String
</th></tr>
<tr class="dark"><td valign="top">
<a href="../../lang/type/boolean+en">Boolean</a>
</td><td valign="top">
<tt>&quot;b&quot;</tt>
</td></tr>
<tr><td valign="top">
<a href="../../lang/type/integer+en">Integer</a>
</td><td valign="top">
<tt>&quot;i&quot;</tt>
</td></tr>
<tr class="dark"><td valign="top">
<a href="../../lang/type/long+en">Long</a>
</td><td valign="top">
<tt>&quot;l&quot;</tt>
</td></tr>
<tr><td valign="top">
<a href="../../lang/type/float+en">Float</a>
</td><td valign="top">
<tt>&quot;f&quot;</tt>
</td></tr>
<tr class="dark"><td valign="top">
<a href="../../lang/date+en">Date</a>
</td><td valign="top">
<tt>&quot;d&quot;</tt>
</td></tr>
<tr><td valign="top">
<a href="../../comp/gb/string+en">String</a>
</td><td valign="top">
<tt>&quot;s&quot;</tt>
</td></tr>
<tr class="dark"><td valign="top">
<a href="../../lang/type/variant+en">Variant</a>
</td><td valign="top">
<tt>&quot;v&quot;</tt>
</td></tr>
<tr><td valign="top">
<a href="../../comp/gb/object+en">Object</a>
</td><td valign="top">
<tt>&quot;o&quot;</tt>
</td></tr>
<tr class="dark"><td valign="top">
Any other class
</td><td valign="top">
<tt>&quot;<i>ClassName</i>;&quot;</tt>
</td></tr>
</table>
<p>
<div class="warning"><table class="none" border="0"><tr><td width="40" valign="top"><img border="0" src="../../../img/info.png" align="center"></td><td valign="top">
Note that in components the <a href="../../lang/type/byte+en">Byte</a> and <a href="../../lang/type/short+en">Short</a> datatypes are always replaced by <a href="../../lang/type/integer+en">Integer</a>,
and the <a href="../../lang/type/single+en">Single</a> is always replaced by <a href="../../lang/type/float+en">Float</a>.
</td></tr></table></div>
<p>
Optional arguments are placed between square brackets (<tt>&quot;[&quot;</tt> & <tt>&quot;]&quot;</tt>).
<p>
The name of the argument can be specified between braces, before the argument datatype.
You cannot specify a name for return datatypes.
<p>
<div class="gray"><font size="-2"><b>Examples
</b></font></div><table class="table" border="0" bordercolor="#000000" cellpadding="4" cellspacing="0"width="100%">
<tr><th>
Declaration
</th><th>
Description
</th></tr>
<tr class="dark"><td valign="top">
<tt>GB_METHOD(&quot;Add&quot;, NULL, collection_add, &quot;(Value)v(Key)s&quot;)</tt>
</td><td valign="top">
A method that takes a <a href="../../lang/type/variant+en">Variant</a> and a <a href="../../comp/gb/string+en">String</a> as arguments, and that returns nothing.
</td></tr>
<tr><td valign="top">
<tt>GB_METHOD(&quot;Exist&quot;, &quot;b&quot;, collection_exist, &quot;(Key)s&quot;)</tt>
</td><td valign="top">
A method that takes a <a href="../../comp/gb/string+en">String</a> as argument, and that returns a <a href="../../lang/type/boolean+en">Boolean</a>.
</td></tr>
<tr class="dark"><td valign="top">
<tt>GB_METHOD(&quot;Clear&quot;, NULL, CARRAY_clear, NULL)</tt>
</td><td valign="top">
A method that takes no argument and that returns nothing.
</td></tr>
<tr><td valign="top">
<tt>GB_METHOD(&quot;Insert&quot;,&nbsp;NULL,&nbsp;CARRAY_insert,&nbsp;&quot;(Array)String[];[(Pos)i]&quot;)</tt>
</td><td valign="top">
A method that take a <a href="../../comp/gb/string+en">String</a> array as first argument, an optional <a href="../../lang/type/integer+en">Integer</a> as second argument,
and that returns nothing.
</td></tr>
<tr class="dark"><td valign="top">
<tt>GB_METHOD(&quot;Sort&quot;, &quot;String[]&quot;, CARRAY_sort, &quot;[(Mode)i]&quot;)</tt>
</td><td valign="top">
A method that takes an optional <a href="../../lang/type/integer+en">Integer</a> as argument, and that returns a <a href="../../comp/gb/string+en">String</a> array.
</td></tr>
<tr><td valign="top">
<tt>GB_STATIC_PROPERTY_READ(&quot;Charset&quot;, &quot;s&quot;, CSYSTEM_charset)</tt>
</td><td valign="top">
A property that returns a <a href="../../comp/gb/string+en">String</a>.
</td></tr>
<tr class="dark"><td valign="top">
<tt>GB_METHOD(&quot;Grab&quot;, &quot;Picture&quot;, CWIDGET_grab, NULL)</tt>
</td><td valign="top">
A property that returns a <a href="../../comp/gb.qt/picture+en">Picture</a> object.
</td></tr>
</table>

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

