IWorkflowManager.RemoveWorkState Method

IWorkflowManagerRemoveWorkState Method

Ingeniux CMS Content Store API

Removes a Work State from the collection.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)

Syntax

bool RemoveWorkState(
	IWorkState workState
)

Function RemoveWorkState ( 
	workState As IWorkState
) As Boolean

bool RemoveWorkState(
	IWorkState^ workState
)

abstract RemoveWorkState : 
        workState : IWorkState -> bool

Type: Boolean
True if the workstate exists in collection, false otherwise.

Exceptions

Exception	Condition
InvalidOperationException	When workstate's name is "Initial", or workstate is still being used in transitions of any workflow definitions.

Remarks

If the workstate's name is "Initial" or the workstate is being used in Transitions of any Workflow defintions, it cannot be deleted.