CAEXObjectExtensionsSetDescription Method

Note: This API is now obsolete.

This method sets a description. If no description exists, it is created.

Namespace: Aml.Engine.CAEX.Extensions
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2

Syntax

C++

Copy

[ObsoleteAttribute("Set the value with the Description Property")]
public static void SetDescription(
	this ICAEXObject caexObject,
	string description
)

<ExtensionAttribute>
<ObsoleteAttribute("Set the value with the Description Property")>
Public Shared Sub SetDescription ( 
	caexObject As ICAEXObject,
	description As String
)

public:
[ExtensionAttribute]
[ObsoleteAttribute(L"Set the value with the Description Property")]
static void SetDescription(
	ICAEXObject^ caexObject, 
	String^ description
)

Parameters

caexObject ICAEXObject: the CAEX object
description String: the description

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ICAEXObject. 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).

Reference

CAEXObjectExtensions Class

Aml.Engine.CAEX.Extensions Namespace