WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool

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

FmcjReadWriteContainer

===Syntax for FmcjReadWriteContainer APIs===============================

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

FmcjReadWriteContainerCopy
  ReadWriteContainerHdl             i
  ReadWriteContainerHdl2            n
  XpRc                              FMC_OK
End

FmcjReadWriteContainerEqual
  ReadWriteContainerHdl             i
  ReadWriteContainerHdl2            i
  XpValue                           TRUE | FALSE
End

FmcjReadWriteContainerDeallocate
  ReadWriteContainerHdl             i
  XpRc                              FMC_OK
End

/* version 3.3.0 or > */
FmcjReadWriteContainerAsReadOnlyContainer
  ReadWriteContainerHdl             i
  ReadOnlyContainerHdl              n
End

FmcjReadWriteContainerSetStringCcsid
  CCSID                             unsigned short
  ReadWriteContainerHdl             i
End

FmcjReadWriteContainerType
  ReadWriteContainerHdl             i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjReadWriteContainerLeafCount
  ReadWriteContainerHdl             i
  XpValue                           unsigned long
End

FmcjReadWriteContainerAllLeafCount
  ReadWriteContainerHdl             i
  XpValue                           unsigned long
End

FmcjReadWriteContainerLeaves
  ReadWriteContainerHdl             i
  ContainerElementVectorHdl         n
End

FmcjReadWriteContainerAllLeaves
  ReadWriteContainerHdl             i
  ContainerElementVectorHdl         n
End

FmcjReadWriteContainerMemberCount
  ReadWriteContainerHdl             i
  XpValue                           unsigned long
End

FmcjReadWriteContainerStructMembers
  ReadWriteContainerHdl             i
  ContainerElementVectorHdl         n
End

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

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

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

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

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

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

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

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

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

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

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

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

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

FmcjReadWriteContainerSetStringValue
  ReadWriteContainerHdl             i
  QualifiedName                     "value" | DEFAULT | NULL
  StringValue                       "value" | NULL
  XpRc                              FMC_OK
End

FmcjReadWriteContainerSetLongValue
  ReadWriteContainerHdl             i
  QualifiedName                     "value" | DEFAULT | NULL
  LongValue                         long
  XpRc                              FMC_OK
End

FmcjReadWriteContainerSetFloatValue
  ReadWriteContainerHdl             i
  QualifiedName                     "value" | DEFAULT | NULL
  FloatValue                        double
  XpRc                              FMC_OK
End

FmcjReadWriteContainerSetBinaryValue
  ReadWriteContainerHdl             i
  QualifiedName                     "value" | DEFAULT | NULL
  BinaryValue                       "hex_value" | NULL
  DataLength                        unsigned long
  XpRc                              FMC_OK
End

FmcjReadWriteContainerSetArrayStringValue
  ReadWriteContainerHdl             i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  StringValue                       "value" | NULL
  XpRc                              FMC_OK
End

FmcjReadWriteContainerSetArrayLongValue
  ReadWriteContainerHdl             i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  LongValue                         long
  XpRc                              FMC_OK
End

FmcjReadWriteContainerSetArrayFloatValue
  ReadWriteContainerHdl             i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  FloatValue                        double
  XpRc                              FMC_OK
End

FmcjReadWriteContainerSetArrayBinaryValue
  ReadWriteContainerHdl             i
  QualifiedName                     "value" | DEFAULT | NULL
  ArrayIndex                        unsigned long
  BinaryValue                       "hex_value" | NULL
  DataLength                        unsigned long
  XpRc                              FMC_OK
End

/* version 3.3.0 or > */
FmcjReadWriteContainerStreamLength
  ReadWriteContainerHdl             i
  XpValue                           unsigned long
End

/* version 3.3.0 or > */
FmcjReadWriteContainerAsStream
  ReadWriteContainerHdl             i
  StreamLength                      unsigned long | DEFAULT
  StreamHdl                         n
  [ StreamOutputFileSpec            "FileSpec" ]
End

Remark:  StreamLength            DEFAULT
         stands for following:
             If Fmcj...StreamLength() is called before,
             then the last retrieved stream length will be passed