Table of Contents

Search

  1. Preface
  2. Introduction to Data Transformation
  3. Data Processor Transformation
  4. Wizard Input and Output Formats
  5. Relational Input and Output
  6. XMap
  7. Libraries
  8. Schema Object
  9. Command Line Interface
  10. Scripts
  11. Parsers
  12. Script Ports
  13. Document Processors
  14. Formats
  15. Data Holders
  16. Anchors
  17. Transformers
  18. Actions
  19. Serializers
  20. Mappers
  21. Locators, Keys, and Indexing
  22. Streamers
  23. Validators, Notifications, and Failure Handling
  24. Validation Rules
  25. Custom Script Components

Data Transformation User Guide

Data Transformation User Guide

C/C++ Interface Example

C/C++ Interface Example

As an example of one of the C/C++ interfaces, consider a document processor that accepts file input. The processor must implement the
CMXProcessFile
function, which has the following syntax:
int CMXProcessFile( void* sessionToken, const CMXContext* params, const IFfile_char_t* in_file, int in_len, IFfile_char_t** out_file, int* out_len, CMXEventReporter* reporter)
The following table describes the parameters:
Parameter
Description
sessionToken
Input parameter. A pointer to the current session.
params
Input parameter. A structure containing the properties that the Script passes to the component.
in_file
Input parameter. The full path of the file upon which the component should operate.
in_len
Input parameter. The length, in bytes, of the input file path.
out_file
Output parameter. The full path of a file that contains the output of the component.
out_len
Output parameter. The length, in bytes, of the output file path.
reporter
Input parameter. Provides the
report
method, which the component can use to write events to the event log.
Return value
Output parameter. 1 if successful, 0 if unsuccessful.


Updated September 26, 2018