ItemExtensions.Promote Method

ItemExtensionsPromote Method

Promote the itme to the specified state

Namespace: Innovator.Client
Assembly: Innovator.Client (in Innovator.Client.dll) Version: 2016.1.15.1759 (2016.01.15.1759)

Syntax

Copy

public static IReadOnlyResult Promote(
	this IItemRef item,
	IConnection conn,
	string state,
	string comments = null
)

<ExtensionAttribute>
Public Shared Function Promote ( 
	item As IItemRef,
	conn As IConnection,
	state As String,
	Optional comments As String = Nothing
) As IReadOnlyResult

Parameters

item: Type: Innovator.ClientIItemRef
Item to promote
conn: Type: Innovator.ClientIConnection
Connection to execute the promotion on
state: Type: SystemString
New state of the item
comments (Optional): Type: SystemString
Comments to include with the promotion

Return Value

Type: IReadOnlyResult

Usage Note

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

Examples

Copy

// Promote the item. Throw an exception if an error occurs.
comp.Promote(conn, "Released").AssertNoError();

Reference

ItemExtensions Class

Innovator.Client Namespace