.ig Copyright (C) 1993,1994 by the author(s). This software is published in the hope that it will be useful, but WITHOUT ANY WARRANTY for any part of this software to work correctly or as described in the manuals. See the ShapeTools Public License for details. Permission is granted to use, copy, modify, or distribute any part of this software but only under the conditions described in the ShapeTools Public License. A copy of this license is supposed to have been given to you along with ShapeTools in a file named LICENSE. Among other things, this copyright notice and the Public License must be preserved on all copies. Author: Andreas Lampen (Andreas.Lampen@cs.tu-berlin.de) $Header: atfstkintro.3[7.0] Fri Jun 25 16:39:27 1993 andy@cs.tu-berlin.de frozen $ .. .TH atfstk_intro 3 "Fri Jun 25 16:39:27 1993" "AtFStk-1.12" "AtFS Toolkit Library" .SH NAME AtFSTK \- introduction to the AtFS (Attribute Filesystem) Toolkit Library .SH SYNOPSIS #include .br #include .sp char* atVersion (void); .sp void atError (int code; char *msg); .br int atErrno; .br char *atErrMsg; .sp int atBindError; .br char atBindErrorMsg[]; .sp .SH DESCRIPTION The AtFS Toolkit library (AtFStk) is a library of functions defined on top of the Attribute Filesystem (AtFS). It is designed to facilitate the contruction of AtFS application programs. .LP \fIatVersion\fP returns a version identification string for the AtFS Toolkit library. .LP \fIatError\fP assigns the given error \fIcode\fP and the error message \fImsg\fP to the global variables \fIatErrno\fP and \fIatErrMsg\fP. Note: The given error message string (\fImsg\fP) is not copied. \fIatError\fP just assigns its address to \fIatErrMsg\fP. The application has to care about the persistence of the message buffer assigned to atErrMsg. .LP \fIatBindError\fP is a flag indicating that something went wrong during the execution of a function from the version binding subsystem (see atbind(3) and atbindrule(3)). When atBindError is set TRUE, \fIatBindErrorMsg\fP holds an explaining error message. The atBindError flag is cleared upon successfull calls, the message buffer remains unchanged. .SH LIST OF FUNCTIONS AND VARIABLES .ta 3.5c 7c \fIName Appears on Page Description\fP .sp .nf atAttrName atattribute.3 return name part of attribute atAttrValue atattribute.3 return value part of attribute atBindAddRule atbindrule.3 add version binding rule to internal database atBindCache atbind.3 perform version binding on object cache atBindDelRule atbindrule.3 delete version binding rule from internal database atBindDisplayErrors atbindrule.3 report errors while parsing version binding rules (variable) atBindError atfstkintro.3 Version binding error flag (variable) atBindErrorMsg atfstkintro.3 Version binding error message (variable) atBindExpandMacro atbind.3 external function for macro expansion (variable) atBindListRules atbindrule.3 list names of all known version binding rules atBindModeOption atbind.3 version binding mode (variable) atBindNoMsg atbind.3 suppress output from version binding rules (variable) atBindOptions atbind.3 parse version binding options from command line atBindRuleFile atbindrule.3 evaluate file containing version binding rules atBindSet atbind.3 perform nonunique version binding atBindSetArgv atbind.3 perprocess command line with version binding atBindShowRules atbindrule.3 dump internal database of version binding rules atBindTestRule atbindrule.3 test existence of version binding rule atBindTrace atbind.3 trace version binding (variable) atBindUsage atbind.3 print usage for version binding options atBindVersion atbind.3 perform unique version binding atCacheKey atcache.3 return unique key attribute atDelVersAlias atversion.3 delete version alias name atErrno atfstkintro.3 AtFStk error code (variable) atError atfstkintro.3 set AtFStk error code and message atErrMsg atfstkintro.3 AtFStk error message (variable) atExpand atexpand.3 switch attribute expansion on/off (variable) atExpandAttrs atexpand.3 expand attribue citations in string atFileClassExt atclass.3 return file class symbol atFreeAttr atattribute.3 recycle memory of attribute string atGen atversion.3 get generation number from compact representation atIsDerived atclass.3 check if object is from a derived object cache atLocalPath atnetwork.3 map network path to local path atMatchAttr atattribute.3 check if attribute value matches given pattern atNetworkPath atnetwork.3 generate network wide path atRev atversion.3 get revision number from compact representation atRetAttr atattribute.3 return attribute value atSaveCache atcache.3 save object to derived object cache and attach key atScanBinding atbind.3 scan version bind directive atScanStatus atprint.3 scan status string atScanUser atuser.3 scan user name atSetAttr atattribute.3 set or modify attribute atSetAttrFile atattribute.3 set or modify attributes with input from file atSetComment atlog.3 set description, intent or log text atSetVersAlias atversion.3 set version alias name atUnlock atlog.3 unlock attributed software object atUserName atuser.3 get user name from user name atUserUid atuser.3 get user id from user structure atUserValid atuser.3 test if user structure is valid atVersion atfstkintro.3 return AtFStk version identification string atVno atversion.3 generate compact version number representation atWriteDate atprint.3 generate string representation of date attribute atWriteMode atprint.3 generate string representation of mode attribute atWriteName atprint.3 write name and path attribute atWriteStatus atprint.3 generate string representation of status attribute .fi .SH SEE ALSO afintro(3) .SH AUTHOR Andreas.Lampen@cs.tu-berlin.de