|
ExtensionCheckOut Method |
Check out the specified file from the vault using the default behavior.
Namespace: CADSharpTools.PDM
Assembly: CADSharpTools.PDM (in CADSharpTools.PDM.dll) Version: 1.4.16.0 (1.4.16)
Syntaxpublic static MethodReturn<bool> CheckOut( this IEdmFile5 file, int Phwnd = 0, string comment = "" )
Parameters
- file
- Type: IEdmFile5
File object. - Phwnd (Optional)
- Type: SystemInt32
Parent window handle. - comment (Optional)
- Type: SystemString
Comment.
Return Value
Type: MethodReturnBooleanMethod return of boolean. True if the check in operation was successful, false if not.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IEdmFile5. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Exceptions| Exception | Condition |
|---|---|
| CADSharpToolsPDMException | Thrown when unable to get the parent folder of the specified file object. |
| NullReferenceException | Thrown when file parameter is null. |
See Also