WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool

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

FmcjReadOnlyContainer

===Syntax for FmcjReadOnlyContainer APIs================================

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

FmcjReadOnlyContainerCopy
  ReadOnlyContainerHdl              i
  ReadOnlyContainerHdl2             n
  XpRc                              FMC_OK
End

FmcjReadOnlyContainerEqual
  ReadOnlyContainerHdl              i
  ReadOnlyContainerHdl2             i
  XpValue                           TRUE | FALSE
End

FmcjReadOnlyContainerDeallocate
  ReadOnlyContainerHdl              i
  XpRc                              FMC_OK
End

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

FmcjReadOnlyContainerSetStringCcsid
  CCSID                             unsigned short
  ReadOnlyContainerHdl              i
End

FmcjReadOnlyContainerType
  ReadOnlyContainerHdl              i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjReadOnlyContainerLeafCount
  ReadOnlyContainerHdl              i
  XpValue                           unsigned long
End

FmcjReadOnlyContainerAllLeafCount
  ReadOnlyContainerHdl              i
  XpValue                           unsigned long
End

FmcjReadOnlyContainerLeaves
  ReadOnlyContainerHdl              i
  ContainerElementVectorHdl         n
End

FmcjReadOnlyContainerAllLeaves
  ReadOnlyContainerHdl              i
  ContainerElementVectorHdl         n
End

FmcjReadOnlyContainerMemberCount
  ReadOnlyContainerHdl              i
  XpValue                           unsigned long
End

FmcjReadOnlyContainerStructMembers
  ReadOnlyContainerHdl              i
  ContainerElementVectorHdl         n
End

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

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

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

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

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

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

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

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

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

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

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

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

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

/* version 3.3.0 or > */
FmcjReadOnlyContainerStreamLength
  ReadOnlyContainerHdl              i
  XpValue                           unsigned long
End

/* version 3.3.0 or > */
FmcjReadOnlyContainerAsStream
  ReadOnlyContainerHdl              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