Topic       : The ATARI Compendium
Author      : Scott Sanders / JAY Software
Version     : 1.25 (20/6/2003)
Subject     : Documentation
Nodes       : 1117
Index Size  : 32614
HCP-Version : 6
Compiled on : Atari
@charset    : UTF-8
@lang       : en
@default    : 
@help       : %About
@options    : +g -i -t4 +y +z
@width      : 100
View Ref-FileXCONTROL Utility Functions
getcookie()                                                        XCONTROL

Syntax

WORD (*xcpb->getcookie)( cookie, pvalue )
LONG cookie;
LONG *pvalue;

Function      getcookie() searches the 'cookie jar' for a given cookie and
              if found returns its stored longword.

Parameters    cookie contains the longword cookie (usually a packed 4
              character ASCII code) to search for. If found, the value of
              the cookie is placed in the LONG pointed to by pvalue.

Binding       err = (*xcpb->getcookie)( cookie, pvalue );

Return Value  getcookie() returns TRUE if the value placed in pvalue is
              valid or FALSE if the cookie was not found.

Comments      This function is useful in locating TSRTermitate and Stay Resident programm
's or other resident
              processes which a CPX is designed to configure.

Group         XCONTROL Utility Functions