svn_wc_notify_t Struct Reference
[notification callback handling]

Structure used in the svn_wc_notify_func2_t function. More...

#include <svn_wc.h>


Data Fields

const char * path
svn_wc_notify_action_t action
svn_node_kind_t kind
const char * mime_type
const svn_lock_tlock
svn_error_terr
svn_wc_notify_state_t content_state
svn_wc_notify_state_t prop_state
svn_wc_notify_lock_state_t lock_state
svn_revnum_t revision


Detailed Description

Structure used in the svn_wc_notify_func2_t function.

path is either absolute or relative to the current working directory (i.e., not relative to an anchor). action describes what happened to path.

kind, content_state, prop_state and lock_state are from after action, not before. lock_state reflects the addition or removal of a lock token in the working copy.

If mime_type is non-null, it indicates the mime-type of path. It is always NULL for directories.

If action is svn_wc_notify_update_completed, revision is the target revision of the update, or SVN_INVALID_REVNUM if not available. If action is svn_wc_notify_blame_revision, revision is the processed revision. In all other cases, revision is SVN_INVALID_REVNUM.

For an action of svn_wc_notify_locked, lock is the lock structure received from the repository. For other actions, it is NULL.

err is NULL, except when action is svn_wc_notify_failed_lock or svn_wc_notify_failed_unlock, in which case it points to an error describing the reason for the failure.

Note that if action is svn_wc_notify_update, then path has already been installed, so it is legitimate for an implementation of svn_wc_notify_func2_t to examine path in the working copy.

Note:
The purpose of the kind, mime_type, content_state, and prop_state fields is to provide "for free" information that an implementation is likely to want, and which it would otherwise be forced to deduce via expensive operations such as reading entries and properties. However, if the caller does not have this information, it will simply pass the corresponding `*_unknown' values, and it is up to the implementation how to handle that (i.e., whether to attempt deduction, or just to punt and give a less informative notification).

Callers of notification functions should use svn_wc_create_notify() to create structures of this type to allow for extensibility.

Since:
New in 1.2.

Definition at line 745 of file svn_wc.h.


The documentation for this struct was generated from the following file:

Generated on Thu Apr 17 13:00:23 2008 for Subversion by  doxygen 1.5.5