ErrorNumber Property

[This is preliminary documentation and subject to change.]

Holds the error number to be reported back to the calling client and logged to the audit trail.

[Visual Basic]
Public Property ErrorNumber as Long
[C++]
HRESULT get_ErrorNumber(Long* pVal);
HRESULT put_ErrorNumber (Long Val);
[IDL]
HRESULT [propget] ErrorNumber([out,retval] Long* pVal);
HRESULT [propput] ErrorNumber ([in] Long Val);

Remarks

On exiting a script the workflow engine automatically looks for an error number in this property.

Your script can terminate a transition by passing a negative number (ErrorNumber < 0) back to the workflow engine. This will log a failure to the audit trail as well. Use IWorkflowSession.ErrorDescription to specify an error description to the audit trail.

If you set the ErrorNumber to a non-negative value (ErrorNumber >= 0), the workflow engine ignores it.

Example

See Also

IWorkflowSession