WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool

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

FmcjProgramTemplate

===Syntax for FmcjProgramTemplate APIs======================================

FmcjProgramTemplateCopy
  ProgramTemplateHdl                    i
  ProgramTemplateHdl2                   n
  XpRc                                  FMC_OK
End

FmcjProgramTemplateDeallocate
  ProgramTemplateHdl                    i
  XpRc                                  FMC_OK
End

FmcjProgramTemplateDescription
  ProgramTemplateHdl                    i
  BufferLength                          unsigned long
  XpValue                               "value" | NULL
End

FmcjProgramTemplateDescriptionIsNull
  ProgramTemplateHdl                    i
  XpValue                               TRUE | FALSE
End

FmcjProgramTemplateEqual
  ProgramTemplateHdl                    i
  ProgramTemplateHdl2                   i
  XpValue                               TRUE | FALSE
End

FmcjProgramTemplateExecutionMode
  ProgramTemplateHdl                    i
  XpValue                             | Fmc_GM_NotSet
                                      | Fmc_GM_Normal
                                      | Fmc_GM_Safe
End

FmcjProgramTemplateExecute
  ProgramTemplateHdl                    i
  [ ReadWriteContainerHdl               i ]
  [ ReadWriteContainerHdl2              i | n ]
  XpRc                                  FMC_OK
End

FmcjProgramTemplateExecuteAsync
  ProgramTemplateHdl                    i
  [ ReadWriteContainerHdl               i ]
  [ ReadWriteContainerHdl2              i | n ]
  CorrelId                              n | NULL
  UserContext                           "value" | NULL
  XpRc                                  FMC_OK
End

FmcjProgramTemplateExecuteWithOptions
  ProgramTemplateHdl                    i
  Priority                              unsigned long
  [ ReadWriteContainerHdl               i ]
  [ ReadWriteContainerHdl2              i | n ]
  XpRc                                  FMC_OK
End

FmcjProgramTemplateExecuteWithOptionsAsync
  ProgramTemplateHdl                    i
  Priority                              unsigned long
  [ ReadWriteContainerHdl               i ]
  [ ReadWriteContainerHdl2              i | n ]
  CorrelId                              n | NULL
  UserContext                           "value" | NULL
  XpRc                                  FMC_OK
End

FmcjProgramTemplateExecutionUser
  ProgramTemplateHdl                    i
  XpValue                             | Fmc_GU_NotSet
                                      | Fmc_GU_Agent
                                      | Fmc_GU_Starter
End

FmcjProgramTemplateIcon
  ProgramTemplateHdl                    i
  BufferLength                          unsigned long
  XpValue                               "value" | NULL
End

FmcjProgramTemplateImplementations
  ProgramTemplateHdl                    i
  ImplementationDataVectorHdl           n
End

FmcjProgramTemplateInContainerAccess
  ProgramTemplateHdl                    i
  XpValue                               TRUE | FALSE
End

FmcjProgramTemplateInitialInContainer
  ProgramTemplateHdl                    i
  ReadWriteContainerHdl                 n
End

FmcjProgramTemplateInitialOutContainer
  ProgramTemplateHdl                    i
  ReadWriteContainerHdl                 n
End

FmcjProgramTemplateIsUnattended
  ProgramTemplateHdl                    i
  XpValue                               TRUE | FALSE
End

FmcjProgramTemplateOutContainerAccess
  ProgramTemplateHdl                    i
  XpValue                               TRUE | FALSE
End

FmcjProgramTemplateProgramTrusted
  ProgramTemplateHdl                    i
  XpValue                               TRUE | FALSE
End

FmcjProgramTemplateStructuresFromActivity
  ProgramTemplateHdl                    i
  XpValue                               TRUE | FALSE
End

FmcjProgramTemplateValidFromTime
  ProgramTemplateHdl                    i
  DateTimeHdl                           n
  XpValue                               "dt_value" | NULL
End

/* version 3.3.0 or > */
FmcjProgramTemplateStreamLength
  ProgramTemplateHdl                i
  XpValue                           unsigned long
End

/* version 3.3.0 or > */
FmcjProgramTemplateAsStream
  ProgramTemplateHdl                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