sttransaction(3) [debian man page]

sttransaction(3)					    ShapeTools Toolkit Library						  sttransaction(3)

NAME

       stAbortThis, stThisTransaction - simple transaction handling

SYNOPSIS

       #include <config.h>
       #include <sttk.h>

       void	    stAbortThis (int domsg);

       struct stTransactionstThisTransaction;

DESCRIPTION

       stAbortThis is part of a simple transaction mechanism on the basis of setjmp(3) and longjmp(3). A transacion is started by setting a return
       point calling setjmp(3) and may be aborted by calling stAbortThis. This outputs a short abort message, cleans up the temporary files (stRm-
       RegisteredFiles(3)) and performs a longjmp(3) operation, returning to the transaction start point.

       The structure variable stThisTransaction carries information about the current transaction. It has the following fields:
       struct stTransaction {
	 char tr_fname[MAXPATHLEN+1];
	 int tr_done;
	 int tr_seqno;
	 int tr_rc;
	 jmp_buf tr_env;
       };

       When  setting  the  transaction return point by calling setjmp(3) the tr_env field must be used as argument to setjmp. The name of the con-
       cerned file should be stored in tr_fname field and the tr_done flag should be cleared.  tr_seqno is the serial number of the current trans-
       action  and must be increased at the beginning of each new transaction. The tr_rc return code can be set to an appropriate return code when
       something went wrong and the transaction was aborted.  When not set by the application, tr_rc will be set nun null by stAbortThis on  abor-
       tion of the transaction. On successful completion, tr_done should be set TRUE.

SEE ALSO

       stRmRegisteredFiles(3), setjmp(3), longjmp(3).

sttk-1.7						     Thu Jun 24 17:43:37 1993						  sttransaction(3)

sttk_intro(3)						    ShapeTools Toolkit Library						     sttk_intro(3)

NAME

       sttk_intro - introduction to the ShapeTools Toolkit Library

SYNOPSIS

       #include <config.h>
       #include <sttk.h>

       char* stVersion (void);

DESCRIPTION

       The ShapeTools Toolkit library (sttk) is a set of functions to be used in various parts of the ShapeTools configuration management toolkit.

       Inclusion of config.h may be omitted when atfs.h is included.

       stVersion returns a version identification string for the ShapeTools Toolkit library.

LIST OF FUNCTIONS AND VARIABLES

       Name	     Appears on PageDescription

       stAbortThis   sttransaction.3abort transaction
       stAskConfirm  stuserio.3    ask user for confirmation
       stCallCmd     stcall.3	   call command
       stCallCmdErrno		   stcall.3error code returned by command (variable)
       stCallEditor  stcall.3	   call editor with default contents
       stCatchSigs   stsignal.3    catch signals
       stCleanup     stsignal.3    do cleanup (remove temporary files etc.)
       stConvertPattern 	   ststring.3convert sh(1) pattern to regex pattern
       stExit	     stsignal.3    stop program execution
       stFindProgram stcall.3	   check if file exists and is executable
       stGetFromStdin		   stuserio.3read text from standard input
       stGetTermWidth		   stuserio.3get current terminal width in columns
       stInterruptAction	   stsignal.3address of signal handler for SIGINT (variable)
       stLog	     stuserio.3    print message
       stMessage     stuserio.3    buffer for constructing messages (variable)
       stMktime      sttime.3	   parse time string
       stParseArgs   stparseargs.3 parse command line arguments
       stProgramName stuserio.3    name how program was called
       stQuietFlag   stuserio.3    suppress normal messages (no error messages) (variable)
       stQuitAction  stsignal.3    address of signal handler for SIGQUIT (variable)
       stRegisterFile		   sttmpfiles.3register file
       stRmRegisteredFiles	   sttmpfiles.3remove all registered files
       stShortUsage  stparseargs.3 print usage string
       stShutupFlag  stuserio.3    supress all messages (variable)
       stStrEnter    ststring.3    enter string to string table
       stStrtok      ststring.3    tokenize string
       stSubstituteString	   ststring.3replace parts of a string by new string
       stTermAction  stsignal.3    address of signal handler for SIGTERM (variable)
       stThisTransaction	   sttransaction.3current transaction (variable)
       stTmpFile     sttmpfiles.3  return unique name for temporary file
       stUnRegisterFile 	   sttmpfiles.3unregister file
       stVersion     sttkintro.3   print version identification string
       stWriteTime   sttime.3	   generate time string

SEE ALSO

       Andreas Lampen and Axel Mahler (Eds.)
       ShapeTools, Technical Report No. 92-14, Technische Universitat Berlin, May 1992

sttk-1.7						     Thu Jun 24 17:43:28 1993						     sttk_intro(3)