WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool

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

FmcjItem

===Syntax for FmcjItem APIs=============================================

FmcjItemCopy
  ItemHdl                           i
  | ItemVectorHdl                   i
  ItemHdl2                          n
  XpRc                              FMC_OK
End

FmcjItemDelete
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpRc                              FMC_OK
End

FmcjItemDeallocate
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpRc                              FMC_OK
End

FmcjItemRefresh
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpRc                              FMC_OK
End

FmcjItemProcessInstance
  ItemHdl                           i
  | ItemVectorHdl                   i
  ProcessInstanceHdl                n
  XpRc                              FMC_OK
End

FmcjItemSetDescription
  ItemHdl                           i
  | ItemVectorHdl                   i
  Description                       "value" | NULL
  XpRc                              FMC_OK
End

FmcjItemTransfer
  ItemHdl                           i
  | ItemVectorHdl                   i
  UserID                            "value" | NULL
  XpRc                              FMC_OK 
End

FmcjItemSetName
  ItemHdl                           i
  | ItemVectorHdl                   i
  ItemName                          "value" | NULL
  XpRc                              FMC_OK
End

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

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

FmcjItemEqual
  ItemHdl                           i
  | ItemVectorHdl                   i
  ItemHdl2                          i
  XpValue                           TRUE | FALSE
End

FmcjItemIsComplete
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpValue                           TRUE | FALSE
End

FmcjItemCategoryIsNull
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpValue                           TRUE | FALSE
End

FmcjItemDescriptionIsNull
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpValue                           TRUE | FALSE
End

FmcjItemDocumentationIsNull
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpValue                           TRUE | FALSE
End

FmcjItemEndTimeIsNull
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpValue                           TRUE | FALSE
End

FmcjItemStartTimeIsNull
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpValue                           TRUE | FALSE
End

FmcjItemKind
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpValue                           Fmc_IT_NotSet
                                  | Fmc_IT_Workitem
                                  | Fmc_IT_ProcessInstanceNotification
                                  | Fmc_IT_FirstActivityInstanceNotification
                                  | Fmc_IT_SecondActivityInstanceNotification
End

FmcjItemReceivedAs
  ItemHdl                           i
  | ItemVectorHdl                   i
  XpValue                           Fmc_IR_NotSet
                                  | Fmc_IR_Normal
                                  | Fmc_IR_Substitute
                                  | Fmc_IR_ProcessAdministrator
                                  | Fmc_IR_SystemAdministrator
                                  | Fmc_IR_ByTransfer
End

FmcjItemProcessInstanceState
  ItemHdl                           i
  | ItemVectorHdl                   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

FmcjItemCategory
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemDescription
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemDocumentation
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemName
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemProcessInstanceSystemGroupName
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemProcessInstanceSystemName
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemInContainerName
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemOutContainerName
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemProcessInstanceName
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemProcessAdmin
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemOwner
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjItemStartTime
  ItemHdl                           i
  | ItemVectorHdl                   i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjItemEndTime
  ItemHdl                           i
  | ItemVectorHdl                   i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjItemCreationTime
  ItemHdl                           i
  | ItemVectorHdl                   i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjItemLastModificationTime
  ItemHdl                           i
  | ItemVectorHdl                   i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjItemReceivedTime
  ItemHdl                           i
  | ItemVectorHdl                   i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjItemIcon
  ItemHdl                           i
  | ItemVectorHdl                   i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

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

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

FmcjItemUpdate
  ItemHdl                           i
  ExecutionDataHdl                  i
  XpRc                              FMC_OK
End