Checkout

Functions
svn_error_t *	svn_client_checkout3 (svn_revnum_t *result_rev, const char *URL, const char *path, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_depth_t depth, svn_boolean_t ignore_externals, svn_boolean_t allow_unver_obstructions, svn_client_ctx_t *ctx, apr_pool_t *pool)
	Checkout a working copy of URL at revision, looked up at peg_revision, using path as the root directory of the newly checked out working copy, and authenticating with the authentication baton cached in ctx.
svn_error_t *	svn_client_checkout2 (svn_revnum_t *result_rev, const char *URL, const char *path, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_boolean_t recurse, svn_boolean_t ignore_externals, svn_client_ctx_t *ctx, apr_pool_t *pool)
	Similar to svn_client_checkout3() but with allow_unver_obstructions always set to FALSE, and depth set according to recurse: if recurse is TRUE, depth is svn_depth_infinity, if recurse is FALSE, depth is svn_depth_files.
svn_error_t *	svn_client_checkout (svn_revnum_t *result_rev, const char *URL, const char *path, const svn_opt_revision_t *revision, svn_boolean_t recurse, svn_client_ctx_t *ctx, apr_pool_t *pool)
	Similar to svn_client_checkout2(), but with peg_revision always set to svn_opt_revision_unspecified and ignore_externals always set to FALSE.

---

Function Documentation

svn_error_t* svn_client_checkout	(	svn_revnum_t *	result_rev,
		const char *	URL,
		const char *	path,
		const svn_opt_revision_t *	revision,
		svn_boolean_t	recurse,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	pool
	)

Similar to svn_client_checkout2(), but with peg_revision always set to svn_opt_revision_unspecified and ignore_externals always set to FALSE.

Deprecated:

Provided for backward compatibility with the 1.1 API.

svn_error_t* svn_client_checkout2	(	svn_revnum_t *	result_rev,
		const char *	URL,
		const char *	path,
		const svn_opt_revision_t *	peg_revision,
		const svn_opt_revision_t *	revision,
		svn_boolean_t	recurse,
		svn_boolean_t	ignore_externals,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	pool
	)

Similar to svn_client_checkout3() but with allow_unver_obstructions always set to FALSE, and depth set according to recurse: if recurse is TRUE, depth is svn_depth_infinity, if recurse is FALSE, depth is svn_depth_files.

Deprecated:

Provided for backward compatibility with the 1.4 API.

svn_error_t* svn_client_checkout3	(	svn_revnum_t *	result_rev,
		const char *	URL,
		const char *	path,
		const svn_opt_revision_t *	peg_revision,
		const svn_opt_revision_t *	revision,
		svn_depth_t	depth,
		svn_boolean_t	ignore_externals,
		svn_boolean_t	allow_unver_obstructions,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	pool
	)

Checkout a working copy of URL at revision, looked up at peg_revision, using path as the root directory of the newly checked out working copy, and authenticating with the authentication baton cached in ctx.

If result_rev is not NULL, set *result_rev to the value of the revision actually checked out from the repository.

If peg_revision->kind is svn_opt_revision_unspecified, then it defaults to svn_opt_revision_head.

revision must be of kind svn_opt_revision_number, svn_opt_revision_head, or svn_opt_revision_date. If revision does not meet these requirements, return the error SVN_ERR_CLIENT_BAD_REVISION.

If depth is svn_depth_infinity, check out fully recursively. Else if it is svn_depth_immediates, check out URL and its immediate entries (subdirectories will be present, but will be at depth svn_depth_empty themselves); else svn_depth_files, check out URL and its file entries, but no subdirectories; else if svn_depth_empty, check out URL as an empty directory at that depth, with no entries present.

If depth is svn_depth_unknown, then behave as if for svn_depth_infinity, except in the case of resuming a previous checkout of path (i.e., updating), in which case use the depth of the existing working copy.

If ignore_externals is set, don't process externals definitions as part of this operation.

If ctx->notify_func2 is non-NULL, invoke ctx->notify_func2 with ctx->notify_baton2 as the checkout progresses.

If allow_unver_obstructions is TRUE then the checkout tolerates existing unversioned items that obstruct added paths from URL. Only obstructions of the same type (file or dir) as the added item are tolerated. The text of obstructing files is left as-is, effectively treating it as a user modification after the checkout. Working properties of obstructing items are set equal to the base properties. If allow_unver_obstructions is FALSE then the checkout will abort if there are any unversioned obstructing items.

If URL refers to a file rather than a directory, return the error SVN_ERR_UNSUPPORTED_FEATURE. If URL does not exist, return the error SVN_ERR_RA_ILLEGAL_URL.

Use pool for any temporary allocation.

Since:

New in 1.5.