Man Linux: Main Page and Category List

NAME

       atSetComment, atUnlock - log and lock handling

SYNOPSIS

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

       int  atSetComment (Af_key *aso, int commentType, char *commentText, int
       mode);

       int atUnlock (Af_key *aso);

DESCRIPTION

       atSetComment sets a  comment  attribute  for  the  attributed  software
       object aso. Valid commentTypes are

       AT_COMMENT_INTENT
                   for   expressing   a   change   intent  describing  planned
                   modifications.

       AT_COMMENT_DESCR
                   for issuing a descriptive text expressing  the  purpose  of
                   the document.

       AT_COMMENT_LOG
                   for writing a change log describing the changes made.

       With  the argument commentText, a default text may be given.  According
       to the mode (see below), the  user  will  be  asked  for  entering  the
       comment  attribute  value.  When  a default text is given, this will be
       offered for modification. With an commentText argument, the previous of
       the according comment attribute is taken as default text.

       With  the  mode  field, the behavior of atSetComment can be influenced.
       Three flags may me set:

       AT_FROMSTDIN
                   advises atSetComment to read the user input  from  standard
                   input, otherwise an editor will be started.

       AT_REUSE    causes  reuse  of  the  comment  text  expressed during the
                   previous invocation of atSetComment, if there was any.

       AT_CONFIRM  lets the user confirm, that an comment shall be  expressed.
                   Otherwise,  atSetComment  asks for the comment text without
                   prior confirmation. This flag is ignored, when AT_FROMSTDIN
                   is set and the change comment is taken from standard input.

       atUnlock unlocks aso by calling af_unlock (manual page af_lock(3)).  If
       a change intent was previously set for aso, this will be eliminated.

DIAGNOSTICS

       atSetComment  and  atUnlock return FALSE (zero) on error. Additionally,
       the atError variable is set and afErrMsg holds a diagnostic message.

ENVIRONMENT

       EDITOR - the default editor to be called.

SEE ALSO

       af_lock(3)