AtFSTK(3) introduction to the AtFS (Attribute Filesystem) Toolkit Library

SYNOPSIS

#include <atfs.h>
#include <atfstk.h>

char* atVersion (void);

void atError (int code; char *msg);
int atErrno;
char *atErrMsg;

int atBindError;
char atBindErrorMsg[];

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.

atVersion returns a version identification string for the AtFS Toolkit library.

atError assigns the given error code and the error message msg to the global variables atErrno and atErrMsg. Note: The given error message string (msg) is not copied. atError just assigns its address to atErrMsg. The application has to care about the persistence of the message buffer assigned to atErrMsg.

atBindError 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, atBindErrorMsg holds an explaining error message. The atBindError flag is cleared upon successfull calls, the message buffer remains unchanged.

LIST OF FUNCTIONS AND VARIABLES

Name   Appears on PageDescription

atAttrNameatattribute.3return name part of attribute
atAttrValueatattribute.3return value part of attribute
atBindAddRuleatbindrule.3add version binding rule to internal database
atBindCacheatbind.3perform version binding on object cache
atBindDelRuleatbindrule.3delete version binding rule from internal database
atBindDisplayErrorsatbindrule.3report errors while parsing version binding rules (variable)
atBindErroratfstkintro.3Version binding error flag (variable)
atBindErrorMsgatfstkintro.3Version binding error message (variable)
atBindExpandMacroatbind.3external function for macro expansion (variable)
atBindListRulesatbindrule.3list names of all known version binding rules
atBindModeOptionatbind.3version binding mode (variable)
atBindNoMsgatbind.3suppress output from version binding rules (variable)
atBindOptionsatbind.3parse version binding options from command line
atBindRuleFileatbindrule.3evaluate file containing version binding rules
atBindSetatbind.3perform nonunique version binding
atBindSetArgvatbind.3perprocess command line with version binding
atBindShowRulesatbindrule.3dump internal database of version binding rules
atBindTestRuleatbindrule.3test existence of version binding rule
atBindTraceatbind.3trace version binding (variable)
atBindUsageatbind.3print usage for version binding options
atBindVersionatbind.3perform unique version binding
atCacheKeyatcache.3return unique key attribute
atDelVersAliasatversion.3delete version alias name
atErrnoatfstkintro.3AtFStk error code (variable)
atErroratfstkintro.3set AtFStk error code and message
atErrMsgatfstkintro.3AtFStk error message (variable)
atExpandatexpand.3switch attribute expansion on/off (variable)
atExpandAttrsatexpand.3expand attribue citations in string
atFileClassExtatclass.3return file class symbol
atFreeAttratattribute.3recycle memory of attribute string
atGen  atversion.3get generation number from compact representation
atIsDerivedatclass.3check if object is from a derived object cache
atLocalPathatnetwork.3map network path to local path
atMatchAttratattribute.3check if attribute value matches given pattern
atNetworkPathatnetwork.3generate network wide path
atRev  atversion.3get revision number from compact representation
atRetAttratattribute.3return attribute value
atSaveCacheatcache.3save object to derived object cache and attach key
atScanBindingatbind.3scan version bind directive
atScanStatusatprint.3scan status string
atScanUseratuser.3scan user name
atSetAttratattribute.3set or modify attribute
atSetAttrFileatattribute.3set or modify attributes with input from file
atSetCommentatlog.3set description, intent or log text
atSetVersAliasatversion.3set version alias name
atUnlockatlog.3unlock attributed software object
atUserNameatuser.3get user name from user name
atUserUidatuser.3get user id from user structure
atUserValidatuser.3test if user structure is valid
atVersionatfstkintro.3return AtFStk version identification string
atVno  atversion.3generate compact version number representation
atWriteDateatprint.3generate string representation of date attribute
atWriteModeatprint.3generate string representation of mode attribute
atWriteNameatprint.3write name and path attribute
atWriteStatusatprint.3generate string representation of status attribute