Guardian Procedure Calls Reference Manual

POOL_DEFINE_ Procedure
Summary
Syntax for C Programmers
Syntax for TAL Programmers
Parameters
Returned Value
Considerations
Example
Related Programming Manual
Summary
The POOL_DEFINE_ procedure designates a portion of a user's stack, global data or a data
segment for use as a pool. It initializes the pool for use by the other procedures in the POOL_...
family.
NOTE: The POOL_... procedures are superseded for native TNS/E callers; see POOL32_... and
POOL64_... Procedures (page 953).
Syntax for C Programmers
#include <cextdecs(POOL_DEFINE_)>
short POOL_DEFINE_ ( short *pool
,__int32_t pool-size
,[ short alignment ]
,[ short priv-only ] );
• CEXTDECS (through the included file TNSINTH) defines 32-bit values as the typedef
__int32_t, which for TNS and TNS/R compiles is defined as long and for TNS/E compiles
is defined as int.
Syntax for TAL Programmers
error := POOL_DEFINE_ ( pool ! i
,pool-size ! i
,[ alignment ] ! i
,[ priv-only ] ); ! i
Parameters
pool
input
INT .EXT:ref:*
specifies the address of the first word of the memory space to be used as the pool, including
the pool header. The address must be aligned according to alignment; the default alignment
is 8 bytes.
pool-size
input
INT(32):value
specifies the size of the pool, including the pool header, in bytes. The maximum size is limited
only by the amount of space available to the application. The address of the end of the pool
POOL_DEFINE_ Procedure 939