NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

ICheckoutService.DoesFileNeedCheckout

Verifies whether a file must be checked out to be edited.

[Visual Basic]
Function DoesFileNeedCheckout( _
   ByVal fileName As String _
) As Boolean
[C#]
bool DoesFileNeedCheckout(
   string fileName
);
[C++]
bool DoesFileNeedCheckout(
   String* fileName
) = 0;
[JScript]
function DoesFileNeedCheckout(
   fileName : String
) : Boolean;

Parameters

fileName
The file to retrieve source control status for.

Return Value

true if file is under source control and needs to be checked out to be edited; otherwise false.

Remarks

It will return true only if the file is under source control and is currently not checked out.

See Also

ICheckoutService Interface | ICheckoutService Members | System.ComponentModel.Design Namespace