XCLE



Void Object structure and methods

Instructions manual


XCLE: eXtensible Concatenative Language Engine
Copyright (C) 2000-2006 Yann LANDRIN-SCHWEITZER a.k.a. Varkhan


This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


Author: Yann LANDRIN-SCHWEITZER
Contact: varkhan@varkhan.net
Homepage: http://www.varkhan.net/


XCLE_Void object type


Function XCLE_VoidAlloc

XCLE_Void XCLE_VoidNew(void) ;
Allocates a new Void object.

Returns:
NULL: if no memory was available
else a new Void object.


Errors:
EINVAL: if a NULL Void was passed as argument
ENOMEM: if no memory was available

Note:
A Void object retains no individual information. It is simply an undefined object.
As such, no Copy and Clone methods are needed. Note that the numeric identifier
for a Void object is 0, to provide a simple default object type.




Function XCLE_VoidFree

void XCLE_VoidFree(XCLE_Void vd) ;
Frees a Void object.

Args:
vd: Void object to free





Generated by textdoc2html - 2006-02-22