Show repository information about a working copy.

Data Structures
struct	svn_info_t
	A structure which describes various system-generated metadata about a working-copy path or URL. More...
Defines
#define	SVN_INFO_SIZE_UNKNOWN   ((apr_size_t) -1)
	The size of the file is unknown.
Typedefs
typedef struct svn_info_t	svn_info_t
	A structure which describes various system-generated metadata about a working-copy path or URL.
typedef svn_error_t *(*	svn_info_receiver_t )(void *baton, const char *path, const svn_info_t *info, apr_pool_t *pool)
	The callback invoked by svn_client_info2().
Functions
svn_info_t *	svn_info_dup (const svn_info_t *info, apr_pool_t *pool)
	Return a duplicate of info, allocated in pool.
svn_error_t *	svn_client_info2 (const char *path_or_url, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_info_receiver_t receiver, void *receiver_baton, svn_depth_t depth, const apr_array_header_t *changelists, svn_client_ctx_t *ctx, apr_pool_t *pool)
	Invoke receiver with receiver_baton to return information about path_or_url in revision.
svn_error_t *	svn_client_info (const char *path_or_url, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_info_receiver_t receiver, void *receiver_baton, svn_boolean_t recurse, svn_client_ctx_t *ctx, apr_pool_t *pool)
	Similar to svn_client_info2() but with changelists passed as NULL, and depth set according to recurse: if recurse is TRUE, depth is svn_depth_infinity, else svn_depth_empty.

---

Define Documentation

#define SVN_INFO_SIZE_UNKNOWN   ((apr_size_t) -1)

The size of the file is unknown.

Used as value in fields of type apr_size_t.

Since:

New in 1.5

Definition at line 4331 of file svn_client.h.

---

Typedef Documentation

typedef svn_error_t*(* svn_info_receiver_t)(void *baton, const char *path, const svn_info_t *info, apr_pool_t *pool)

The callback invoked by svn_client_info2().

Each invocation describes path with the information present in info. Note that any fields within info may be NULL if information is unavailable. Use pool for all temporary allocation.

Since:

New in 1.2.

Definition at line 4455 of file svn_client.h.

typedef struct svn_info_t svn_info_t

A structure which describes various system-generated metadata about a working-copy path or URL.

Note:

Fields may be added to the end of this structure in future versions. Therefore, users shouldn't allocate structures of this type, to preserve binary compatibility.

Since:

New in 1.2.

---

Function Documentation

svn_error_t* svn_client_info	(	const char *	path_or_url,
		const svn_opt_revision_t *	peg_revision,
		const svn_opt_revision_t *	revision,
		svn_info_receiver_t	receiver,
		void *	receiver_baton,
		svn_boolean_t	recurse,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	pool
	)

Similar to svn_client_info2() but with changelists passed as NULL, and depth set according to recurse: if recurse is TRUE, depth is svn_depth_infinity, else svn_depth_empty.

Deprecated:

Provided for backward compatibility with the 1.2 API.

svn_error_t* svn_client_info2	(	const char *	path_or_url,
		const svn_opt_revision_t *	peg_revision,
		const svn_opt_revision_t *	revision,
		svn_info_receiver_t	receiver,
		void *	receiver_baton,
		svn_depth_t	depth,
		const apr_array_header_t *	changelists,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	pool
	)

Invoke receiver with receiver_baton to return information about path_or_url in revision.

The information returned is system-generated metadata, not the sort of "property" metadata created by users. See svn_info_t.

If both revision arguments are either svn_opt_revision_unspecified or NULL, then information will be pulled solely from the working copy; no network connections will be made.

Otherwise, information will be pulled from a repository. The actual node revision selected is determined by the path_or_url as it exists in peg_revision. If peg_revision->kind is svn_opt_revision_unspecified, then it defaults to svn_opt_revision_head for URLs or svn_opt_revision_working for WC targets.

If path_or_url is not a local path, then if revision is of kind svn_opt_revision_previous (or some other kind that requires a local path), an error will be returned, because the desired revision cannot be determined.

Use the authentication baton cached in ctx to authenticate against the repository.

If path_or_url is a file, just invoke receiver on it. If it is a directory, then descend according to depth. If depth is svn_depth_empty, invoke receiver on path_or_url and nothing else; if svn_depth_files, on path_or_url and its immediate file children; if svn_depth_immediates, the preceding plus on each immediate subdirectory; if svn_depth_infinity, then recurse fully, invoking receiver on path_or_url and everything beneath it.

changelists is an array of const char * changelist names, used as a restrictive filter on items whose info is reported; that is, don't report info about any item unless it's a member of one of those changelists. If changelists is empty (or altogether NULL), no changelist filtering occurs.

Since:

New in 1.5.

svn_info_t* svn_info_dup	(	const svn_info_t *	info,
		apr_pool_t *	pool
	)

Return a duplicate of info, allocated in pool.

No part of the new structure will be shared with info.

Since:

New in 1.3.