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.CheckoutFile

Checks out the specified file, if possible.

[Visual Basic]
Sub CheckoutFile( _
   ByVal fileName As String _
)
[C#]
void CheckoutFile(
   string fileName
);
[C++]
void CheckoutFile(
   String* fileName
) = 0;
[JScript]
function CheckoutFile(
   fileName : String
);

Parameters

fileName
The file to check out.

Exceptions

Exception Type Condition
System.CheckoutException.Canceled The file cannot be checked out to be edited.

Remarks

If the file needs be be checked out to be edited, and it cannot be checked out, a CheckoutException exception is thrown. If the file is already checked out, or does not need to be checked out, no exception is thrown and the function returns.

See Also

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