WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool

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

FmcjContainer

===Syntax for FmcjContainer APIs========================================

Remark:  ProgramID               DEFAULT
         stands for following:
             If FmcjPEAProgramID(...) is called before,
             then the retrieved ProgramID will be passed
             If the application is the DLL version,
             then the DLL entry point argument ProgramID will be passed
             Otherwise a NULL pointer will be passed.
         ProgramID               "value": Any externaly defined value
         ProgramID               NULL:      A NULL pointer will be passed.

Remark:  QualifiedName           DEFAULT
         stands for following:
             If FmcjContainerElementFullName() is called before,
             then the last retrieved Qualified(Full)Name will be passed

---activity implementation functions------------------------------------

FmcjContainerInContainer
  ReadOnlyContainerHdl              n
  XpRc                              FMC_OK
End

FmcjContainerOutContainer
  ReadWriteContainerHdl             n
  XpRc                              FMC_OK
End

FmcjContainerSetOutContainer
  ReadWriteContainerHdl             i
  XpRc                              FMC_OK
End

FmcjContainerSetStringCcsid
  CCSID                             unsigned short
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
End

FmcjContainerRemoteInContainer
  ProgramID                         DEFAULT
                                  | "value"
                                  | NULL
  | ProgramIDInputFileSpec          "FileSpec"
  ReadOnlyContainerHdl              n
  XpRc                              FMC_OK
End

FmcjContainerRemoteOutContainer
  ProgramID                         DEFAULT
                                  | "value"
                                  | NULL
  | ProgramIDInputFileSpec          "FileSpec"
  ReadWriteContainerHdl             n
  XpRc                              FMC_OK
End

FmcjContainerSetRemoteOutContainer
  ProgramID                         DEFAULT
                                  | "value"
                                  | NULL
  | ProgramIDInputFileSpec          "FileSpec"
  ReadWriteContainerHdl             i
  XpRc                              FMC_OK
End

---special methods based on MQ Workflow Worklist Handler APIs-----------

Container_DUMP_ALL
dumps the complete data structure (including all values)
of an input or an output container.

FmcjContainer_DUMP_ALL
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  [ IncludePredefinedDataStructures TRUE | FALSE ]
End

Container_DUMP_ALL_2
dumps the complete data structure (including all values)
of an input or an output container.
This algorithm dumps only the leaves, but with their full (dotted) name.

FmcjContainer_DUMP_ALL_2
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  [ IncludePredefinedDataStructures TRUE | FALSE ]
End

FmcjContainer_COPY...:
  copies the values of the input container members to the output
  container if both containers are of the same type.
  If a data member of an input container is not set, then the related
  member of output container will NOT be changed.
  Container_COPY_IN_TO_OUT:
    - via ElementName-algorithm
    - does NOT include the PREDEFINED DS members
    - does NOT include ...SetContainer()
  Container_COPY_IN_TO_OUT_2:
    - via AllLeaves/ElementFullName-algorithm
    - does INCLUDE the PREDEFINED DS members
    - does NOT include ...SetContainer()

FmcjContainer_COPY_IN_TO_OUT
  ReadOnlyContainerHdl              i
  ReadWriteContainerHdl             i
End

FmcjContainer_COPY_IN_TO_OUT_2
  ReadOnlyContainerHdl              i
  ReadWriteContainerHdl             i
End

---access functions-----------------------------------------------------

FmcjContainerType
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjContainerLeafCount
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  XpValue                           unsigned long
End

FmcjContainerAllLeafCount
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  XpValue                           unsigned long
End

FmcjContainerLeaves
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  ContainerElementVectorHdl         n
End

FmcjContainerAllLeaves
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  ContainerElementVectorHdl         n
End

FmcjContainerMemberCount
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  XpValue                           unsigned long
End

FmcjContainerStructMembers
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  ContainerElementVectorHdl         n
End

FmcjContainerGetElement
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  ContainerElementHdl               n
  XpRc                              FMC_OK
End

FmcjContainerStringLength
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  XpValue                           unsigned long
End

FmcjContainerStringValue
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  BufferLength                      unsigned long
  XpValue                           "value"
  XpRc                              FMC_OK
End

FmcjContainerLongValue
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  XpValue                           long
  XpRc                              FMC_OK
End

FmcjContainerFloatValue
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  XpValue                           double
  XpRc                              FMC_OK
End

FmcjContainerBinaryLength
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  XpValue                           unsigned long
End

FmcjContainerBinaryValue
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  BufferLength                      unsigned long
  XpValue                           "hex_value" | NULL
  XpRc                              FMC_OK
End

FmcjContainerArrayStringLength
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  XpValue                           unsigned long
End

FmcjContainerArrayStringValue
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  BufferLength                      unsigned long
  XpValue                           "value"
  XpRc                              FMC_OK
End

FmcjContainerArrayLongValue
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  XpValue                           long
  XpRc                              FMC_OK
End

FmcjContainerArrayFloatValue
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  XpValue                           double
  XpRc                              FMC_OK
End

FmcjContainerArrayBinaryLength
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  XpValue                           unsigned long
End

FmcjContainerArrayBinaryValue
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  BufferLength                      unsigned long
  XpValue                           "hex_value" | NULL
  XpRc                              FMC_OK
End