Click or drag to resize

ExtensionSetDataCardVariable Method

Sets the value of the vault data card variable for the specified file.

Namespace:  CADSharpTools.PDM
Assembly:  CADSharpTools.PDM (in CADSharpTools.PDM.dll) Version: 1.4.16.0 (1.4.16)
Syntax
Copy
public static MethodReturn<bool> SetDataCardVariable(
	this IEdmFile5 file,
	string variable,
	string configurationName = "@",
	Object value = null
)

Parameters

file
Type: IEdmFile5
File object.
variable
Type: SystemString
Vault variable name.
configurationName (Optional)
Type: SystemString
Configuration name. Default is "@".
value (Optional)
Type: SystemObject
New value of the data card variable.

Return Value

Type: MethodReturnBoolean
MethodReturn of boolean: True if 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
ExceptionCondition
CADSharpToolsPDMExceptionThrown when:
  • unable to get the parent folder of the specified file object.
  • the file is checked in.
NullReferenceExceptionThrown when file parameter is null.
See Also