WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool

[prev][next][parent][TOC]

FmcjProcessInstanceNotification

===Syntax for FmcjProcessInstanceNotification APIs======================

FmcjProcessInstanceNotificationUpdate
  ProcessInstanceNotificationHdl          i
  ExecutionDataHdl                        i
  XpRc                                    FMC_OK
End

FmcjProcessInstanceNotificationCopy
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  ProcessInstanceNotificationHdl2         n
  XpRc                                    FMC_OK
End

FmcjProcessInstanceNotificationDelete
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpRc                                    FMC_OK
End

FmcjProcessInstanceNotificationDeallocate
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpRc                                    FMC_OK
End

FmcjProcessInstanceNotificationRefresh
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpRc                                    FMC_OK
End

FmcjProcessInstanceNotificationProcessInstance
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  ProcessInstanceHdl                      n
  XpRc                                    FMC_OK
End

FmcjProcessInstanceNotificationSetDescription
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  Description                             "value" | NULL
  XpRc                                    FMC_OK
End

FmcjProcessInstanceNotificationTransfer
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  UserID                                  "value" | NULL
  XpRc                                    FMC_OK 
End

FmcjProcessInstanceNotificationSetName
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  ProcessInstanceNotificationName         "value" | NULL
  XpRc                                    FMC_OK
End

/* the following API is deprecated (version 3.3.0) */
FmcjProcessInstanceNotificationPersistentObject
  ExecutionServiceHdl                     i
  PersistentOidHdl                        i
  | PersistentOidInputFileSpec            "FileSpec"
  ProcessInstanceNotificationHdl          n
  XpRc                                    FMC_OK
End

FmcjProcessInstanceNotificationPersistentOid
  ProcessInstanceNotificationHdl          i
  PersistentOidHdl                        n
  [ PersistentOidOutputFileSpec           "FileSpec" ]
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationPersistentOidOfProcessInstance
  ProcessInstanceNotificationHdl          i
  PersistentOidHdl                        n
  [ PersistentOidOutputFileSpec           "FileSpec" ]
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationEqual
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  ProcessInstanceNotificationHdl2         i
  XpValue                                 TRUE | FALSE
End

FmcjProcessInstanceNotificationIsComplete
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpValue                                 TRUE | FALSE
End

FmcjProcessInstanceNotificationCategoryIsNull
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpValue                                 TRUE | FALSE
End

FmcjProcessInstanceNotificationDescriptionIsNull
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpValue                                 TRUE | FALSE
End

FmcjProcessInstanceNotificationDocumentationIsNull
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpValue                                 TRUE | FALSE
End

FmcjProcessInstanceNotificationEndTimeIsNull
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpValue                                 TRUE | FALSE
End

FmcjProcessInstanceNotificationStartTimeIsNull
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpValue                                 TRUE | FALSE
End

FmcjProcessInstanceNotificationKind
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpValue                                 Fmc_IT_NotSet
                                        | Fmc_IT_Workitem
                                        | Fmc_IT_ProcessInstanceNotification
                                        | Fmc_IT_FirstActivityInstanceNotification
                                        | Fmc_IT_SecondActivityInstanceNotification
End

FmcjProcessInstanceNotificationReceivedAs
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  XpValue                                 Fmc_IR_NotSet
                                        | Fmc_IR_Normal
                                        | Fmc_IR_Substitute
                                        | Fmc_IR_ProcessAdministrator
                                        | Fmc_IR_SystemAdministrator
                                        | Fmc_IR_ByTransfer
End

FmcjProcessInstanceNotificationProcessInstanceState
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  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

FmcjProcessInstanceNotificationCategory
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationDescription
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationDocumentation
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationName
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationInContainerName
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationOutContainerName
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationProcessInstanceName
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationProcessInstanceSystemGroupName
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationProcessInstanceSystemName
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationProcessAdmin
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationOwner
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

FmcjProcessInstanceNotificationStartTime
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  DateTimeHdl                             n
  XpValue                                 "dt_value" | NULL
End

FmcjProcessInstanceNotificationEndTime
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  DateTimeHdl                             n
  XpValue                                 "dt_value" | NULL
End

FmcjProcessInstanceNotificationCreationTime
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  DateTimeHdl                             n
  XpValue                                 "dt_value" | NULL
End

FmcjProcessInstanceNotificationLastModificationTime
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  DateTimeHdl                             n
  XpValue                                 "dt_value" | NULL
End

/* version 3.3.0 or > */
FmcjProcessInstanceNotificationNotificationTime
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  DateTimeHdl                             n
  XpValue                                 "dt_value" | NULL
End

FmcjProcessInstanceNotificationReceivedTime
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  DateTimeHdl                             n
  XpValue                                 "dt_value" | NULL
End

FmcjProcessInstanceNotificationIcon
  ProcessInstanceNotificationHdl          i
  | ProcessInstanceNotificationVectorHdl  i
  BufferLength                            unsigned long
  XpValue                                 "value" | NULL
End

/* the following API is deprecated (version 3.3.0) */
FmcjProcessInstanceNotificationObtainProcessInstanceMonitor
  ProcessInstanceNotificationHdl    i
  Deep                              TRUE | FALSE
  ProcessInstanceMonitorHdl         n
  XpRc                              FMC_OK
End

/* version 3.3.0 or > */
FmcjProcessInstanceNotificationObtainProcessMonitor
  ProcessInstanceNotificationHdl    i
  Deep                              TRUE | FALSE
  InstanceMonitorHdl                n
  XpRc                              FMC_OK
End