WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool
[prev][next][parent][TOC]
FmcjActivityInstance
===Syntax for FmcjActivityInstance APIs=================================
Remark: When you select option "ActivityInstanceVectorHdl" instead of
"ActivityInstanceHdl", the API call applies to ALL elements
of the vector.
FmcjActivityInstanceCopy
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
ActivityInstanceHdl2 n
XpRc FMC_OK
End
FmcjActivityInstanceDeallocate
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpRc FMC_OK
End
FmcjActivityInstanceInContainer
ActivityInstanceHdl i
ReadOnlyContainerHdl n
XpRc FMC_OK
End
FmcjActivityInstanceOutContainer
ActivityInstanceHdl i
ReadOnlyContainerHdl n
XpRc FMC_OK
End
/* version 3.3.0 or > */
FmcjActivityInstanceForceFinish
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
[ ReadOnlyContainerHdl i
| ReadWriteContainerHdl i ]
XpRc FMC_OK
End
/* version 3.3.0 or > */
FmcjActivityInstanceForceRestart
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
[ ReadOnlyContainerHdl i
| ReadWriteContainerHdl i ]
XpRc FMC_OK
End
/* the following API is deprecated (version 3.3.0) */
FmcjActivityInstancePersistentObject
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
ActivityInstanceHdl n
XpRc FMC_OK
End
FmcjActivityInstancePersistentOid
ActivityInstanceHdl i
PersistentOidHdl n
[ PersistentOidOutputFileSpec "FileSpec" ]
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceEqual
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
ActivityInstanceHdl2 i
XpValue TRUE | FALSE
End
FmcjActivityInstanceStateOfNotification
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue Fmc_AE_NotSet
| Fmc_AE_NoNotification
| Fmc_AE_FirstNotification
| Fmc_AE_SecondNotification
End
FmcjActivityInstanceKind
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue Fmc_AT_NotSet
| Fmc_AT_Process
| Fmc_AT_Program
| Fmc_AT_Block
End
FmcjActivityInstanceIsComplete
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceSecondNotificationTimeIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceCategoryIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceDescriptionIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceDocumentationIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceEndTimeIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceActivationTimeIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceStartTimeIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceFirstNotificationTimeIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
/* version 3.3.0 or > */
FmcjActivityInstanceExpirationTimeIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceImplementationIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceStarterIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceErrorReasonIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstancePriorityIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceProcessAdminIsNull
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceManualExitMode
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceManualStartMode
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue TRUE | FALSE
End
FmcjActivityInstanceState
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue Fmc_AS_NotSet
| Fmc_AS_Ready
| Fmc_AS_Running
| Fmc_AS_Finished
| Fmc_AS_Terminated
| Fmc_AS_Suspended
| Fmc_AS_Inactive
| Fmc_AS_CheckedOut
| Fmc_AS_InError
| Fmc_AS_Executed
| Fmc_AS_Planning
| Fmc_AS_ForceFinished
| Fmc_AS_Skipped
| Fmc_AS_Deleted
| Fmc_AS_Terminating
| Fmc_AS_Suspending
| Fmc_AS_Expired
End
FmcjActivityInstanceProcessInstanceState
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue Fmc_PS_NotSet
| Fmc_PS_Ready
| Fmc_PS_Running
| Fmc_PS_Finished
| Fmc_PS_Terminated
| Fmc_PS_Suspended
| Fmc_PS_Terminating
| Fmc_PS_Suspending
| Fmc_PS_Deleted
End
FmcjActivityInstanceCategory
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceDescription
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceDocumentation
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceName
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceInContainerName
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceOutContainerName
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceProcessInstanceName
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceStarter
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceImplementation
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceStartCondition
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceExitCondition
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceProcessAdmin
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceProcessInstanceSystemGroupName
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceProcessInstanceSystemName
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceFullName
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstanceStartTime
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
DateTimeHdl n
XpValue "dt_value" | NULL
End
FmcjActivityInstanceEndTime
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
DateTimeHdl n
XpValue "dt_value" | NULL
End
FmcjActivityInstanceFirstNotificationTime
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
DateTimeHdl n
XpValue "dt_value" | NULL
End
FmcjActivityInstanceSecondNotificationTime
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
DateTimeHdl n
XpValue "dt_value" | NULL
End
FmcjActivityInstanceLastModificationTime
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
DateTimeHdl n
XpValue "dt_value" | NULL
End
FmcjActivityInstanceLastStateChangeTime
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
DateTimeHdl n
XpValue "dt_value" | NULL
End
FmcjActivityInstanceActivationTime
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
DateTimeHdl n
XpValue "dt_value" | NULL
End
/* version 3.3.0 or > */
FmcjActivityInstanceExpirationTime
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
DateTimeHdl n
XpValue "dt_value" | NULL
End
FmcjActivityInstanceIcon
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjActivityInstancePriority
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpValue unsigned long
End
FmcjActivityInstanceStaff
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
StringVectorHdl n
XpValue "value1;value2;..."
End
FmcjActivityInstanceFirstNotifiedPersons
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
StringVectorHdl n
XpValue "value1;value2;..."
End
FmcjActivityInstanceSecondNotifiedPersons
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
StringVectorHdl n
XpValue "value1;value2;..."
End
FmcjActivityInstanceSupportTools
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
StringVectorHdl n
XpValue "value1;value2;..."
End
FmcjActivityInstanceSubProcessInstance
ActivityInstanceHdl i
ProcessInstanceHdl n
XpRc FMC_OK
End
/* the following API is deprecated (version 3.3.0) */
FmcjActivityInstanceObtainProcessInstanceMonitor
ActivityInstanceHdl i
Deep TRUE | FALSE
ProcessInstanceMonitorHdl n
XpRc FMC_OK
End
/* version 3.3.0 or > */
FmcjActivityInstanceObtainProcessMonitor
ActivityInstanceHdl i
Deep TRUE | FALSE
InstanceMonitorHdl n
XpRc FMC_OK
End
FmcjActivityInstanceErrorReason
ActivityInstanceHdl i
ErrorHdl n
End
FmcjActivityInstanceSymbolLayout
ActivityInstanceHdl i
SymbolLayoutHdl n
End
FmcjActivityInstanceTerminate
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpRc FMC_OK
End
/* version 3.3.0 or > */
FmcjActivityInstanceRefresh
ActivityInstanceHdl i
| ActivityInstanceVectorHdl i
XpRc FMC_OK
End