Seed7 - The extensible programming language
Seed7 FAQ Manual Screenshots Examples Libraries Algorithms Download Links
Libraries AES ARC4 Array ASN.1 Bigfile Bigint Bigrat Bin32 Bin64 Bitdata Bitmapfont Bitset Bitsetof Boolean Browser Bstring Bytedata Cards Category CC config Cgi Cgi dialog Char Charsets Cipher Clib_file Color CLI Commands Complex Console Crc32 Deflate DES Dialog Dir Draw Duration Echo Editline Enable_input Enable_io Enable_output Encoding Environment External_file File File system Float Font Forloop Ftp Getf Gethttp Gethttps Graph Graph_file Gzip Hash Hashsetof Hmac Html_ent Httpserv Idxarray Image Inflate Inflate file Inifile Integer Keybd Line Listener LZW Make Math Msgdigest Null_file Osfiles Picture utility Pixmap_file Pixmapfont PKCS #1 Poll Process Progs Propertyfile Rational Reference Ref_list Scanfile Scanstri Set Shell Smtp Sockbase Socket SQL base Stdio Strifile String Stritext Subrange Tar Text Time TLS/SSL Triple DES Unicode Utf16 Utf8 Vectorfont 3D Vector Wildcard Window Wrinum X.509 Xmldom Xml_ent Zip
Libraries
Reference Source Code
 previous   up   next 

Types
reference
The type reference describes a reference to any object.

reference

const type: reference

The type reference describes a reference to any object.


Abstract data types
type
getType (in reference: aReference)
Get the type of the referenced object.

getType

const func type: getType (in reference: aReference)

Get the type of the referenced object.

Returns:
the type of the object referenced by aReference.

Constant Summary
reference
NIL
Reference to no element.

Operator Summary
boolean
(in reference: ref1) = (in reference: ref2)
Check if two references are equal.
boolean
(in reference: ref1) <> (in reference: ref2)
Check if two references are equal.

Function Summary
integer
compare (in reference: ref1, in reference: ref2)
Compare two references.
integer
hashCode (in reference: aReference)
Compute the hash value of a reference.
string
str (ref reference: aReference)
Convert a reference to a string.
void
setType (in reference: aReference, in type: aType)
Set the type of the object 'aReference' to 'aType'.

Constant Detail

NIL

const reference: NIL

Reference to no element.


Operator Detail

=

const func boolean: (in reference: ref1) = (in reference: ref2)

Check if two references are equal.

Returns:
TRUE if both references are equal, FALSE otherwise.

<>

const func boolean: (in reference: ref1) <> (in reference: ref2)

Check if two references are equal.

Returns:
FALSE if both references are equal, TRUE otherwise.

Function Detail

compare

const func integer: compare (in reference: ref1, in reference: ref2)

Compare two references.

Returns:
-1, 0 or 1 if the first argument is considered to be respectively less than, equal to, or greater than the second.

hashCode

const func integer: hashCode (in reference: aReference)

Compute the hash value of a reference.

Returns:
the hash value.

str

const func string: str (ref reference: aReference)

Convert a reference to a string.

Returns:
the string result of the conversion.
Raises:
MEMORY_ERROR - Not enough memory to represent the result.

setType

const proc: setType (in reference: aReference, in type: aType)

Set the type of the object 'aReference' to 'aType'.

Raises:
RANGE_ERROR - When 'aReference' is NIL.


 previous   up   next