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
 Path, either absolute or relative to the current working directory (i.e., not relative to an anchor).

svn_wc_notify_action_t action
 Action that describes what happened to path.

svn_node_kind_t kind
 Node kind of path.

const char * mime_type
 If non-NULL, indicates the mime-type of path.

const svn_lock_tlock
 Points to the lock structure received from the repository when action is svn_wc_notify_locked.

svn_error_terr
 Points to an error describing the reason for the failure when action is svn_wc_notify_failed_lock or svn_wc_notify_failed_unlock.

svn_wc_notify_state_t content_state
 The type of notification that is occurring about node content.

svn_wc_notify_state_t prop_state
 The type of notification that is occurring about node properties.

svn_wc_notify_lock_state_t lock_state
 Reflects the addition or removal of a lock token in the working copy.

svn_revnum_t revision
 When action is svn_wc_notify_update_completed, target revision of the update, or SVN_INVALID_REVNUM if not available; when action is svn_wc_notify_blame_revision, processed revision.

const char * changelist_name
 When action is svn_wc_notify_changelist_add or name.

svn_merge_range_tmerge_range
 When action is svn_wc_notify_merge_begin, and both the left and right sides of the merge are from the same URL.


Detailed Description

Structure used in the svn_wc_notify_func2_t function.

kind, content_state, prop_state and lock_state are from after action, not before.

Note:
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.

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 872 of file svn_wc.h.


Field Documentation

const char* svn_wc_notify_t::changelist_name
 

When action is svn_wc_notify_changelist_add or name.

In all other cases, it is NULL.

Definition at line 904 of file svn_wc.h.

svn_error_t* svn_wc_notify_t::err
 

Points to an error describing the reason for the failure when action is svn_wc_notify_failed_lock or svn_wc_notify_failed_unlock.

Is NULL otherwise.

Definition at line 890 of file svn_wc.h.

const svn_lock_t* svn_wc_notify_t::lock
 

Points to the lock structure received from the repository when action is svn_wc_notify_locked.

For other actions, it is NULL.

Definition at line 886 of file svn_wc.h.

svn_merge_range_t* svn_wc_notify_t::merge_range
 

When action is svn_wc_notify_merge_begin, and both the left and right sides of the merge are from the same URL.

In all other cases, it is NULL.

Definition at line 908 of file svn_wc.h.

const char* svn_wc_notify_t::mime_type
 

If non-NULL, indicates the mime-type of path.

It is always NULL for directories.

Definition at line 882 of file svn_wc.h.

svn_revnum_t svn_wc_notify_t::revision
 

When action is svn_wc_notify_update_completed, target revision of the update, or SVN_INVALID_REVNUM if not available; when action is svn_wc_notify_blame_revision, processed revision.

In all other cases, it is SVN_INVALID_REVNUM.

Definition at line 901 of file svn_wc.h.


The documentation for this struct was generated from the following file:
Generated on Sun Dec 21 20:02:56 2008 for Subversion by doxygen 1.3.5