int CheckOut(
	bool recursive
)

Function CheckOut ( 
	recursive As Boolean
) As Integer

int CheckOut(
	bool recursive
)

abstract CheckOut : 
        recursive : bool -> int 

Parameters

recursive

Type: SystemBoolean
Specifies whether to also check out the descendants of this page.

Return Value

If a page was already checked out, this method will continue to check out descendants. If not a recursive operation, nothing will happen.

The current user must have permission to check in and check out pages. Otherwise, an error will be thrown.

The current user must have Full Access to this page. Otherwise, an error will be thrown.

If the page was assigned to another user and the current user doesn't have the right to assign a page, an error will be thrown.

Two events are fired during execution of this method: BeforePageCheckOut and AfterPageCheckOut.

Reference