Namespace: Autodesk.Revit.DB Class: WorksharingUtils

WorksharingUtils.GetCheckoutStatus(Document, ElementId, String)

Method

Description:
Gets the ownership status and outputs the owner of an element.

Remarks:

This method returns a locally cached value which may not be up to date with the current state of the element in the central. Because of this, the return value is suitable for reporting to an interactive user (e.g. via a mechanism similar to Worksharing display mode), but cannot be considered a reliable indication of whether the element can be immediately edited by the application. Also, the return value may not be dependable in the middle of a local transaction. See the remarks on WorksharingUtils for more details.

For performance reasons, the model is not validated to be workshared, and the element id is also not validated; the element will not be expanded.

Syntax

public static CheckoutStatus GetCheckoutStatus(
	Document document,
	ElementId elementId,
	out string owner
)

Public Shared Function GetCheckoutStatus ( 
	document As Document,
	elementId As ElementId,
	<OutAttribute> ByRef owner As String
) As CheckoutStatus

public:
static CheckoutStatus GetCheckoutStatus(
	Document^ document, 
	ElementId^ elementId, 
	[OutAttribute] String^% owner
)

static member GetCheckoutStatus : 
        document : Document * 
        elementId : ElementId * 
        owner : string byref -> CheckoutStatus

Parameters

Parameter	Type	Description
document	Document	The document containing the element.
elementId	ElementId	The id of the element.
owner	String	The owner of the element, or an empty string if no one owns it.

Return Value

Type	Description
CheckoutStatus	An indication of whether the element is unowned, owned by the current user, or owned by another user.

Exceptions

Exception	Condition
ArgumentNullException	A non-optional argument was null