TRADACOMSWriter Class

Properties   Methods   Events   Config Settings   Errors  

The TRADACOMSWriter class is optimized for TRADACOMS documents, providing a simple way to create TRADACOMS documents.

Syntax

TRADACOMSWriter

Remarks

The class allows you to create a document from scratch. The class allows you to create an EDI document one segment at a time. Here's how a document would normally be created:

1. Call LoadSchema to load the necessary schemas for the transactions that will be used.
2. Specify where to write the output document by setting the OutputFile property or SetOutputStream method, or set neither and check the OutputData property.
3. Create a new interchange start segment using the StartInterchangeHeader method and set its properties using WriteElementString and WriteComponentString.
4. To write a basic element value to the current location, call the WriteElementString method. For complex element values, there are two possibilities, elements which are split into components, and elements which repeat. To write these complex element values, use the StartElement and EndElement methods, with WriteComponentString and RepeatElement methods for writing the values. (Examples available below).
5. Create a new functional group using StartFunctionalGroupHeader and set its properties using WriteElementString and WriteComponentString.
6. Create a new transaction using StartTransactionHeader and set the properties for the header segment.
7. Write all the data for the transaction by creating new data segments using StartSegment and providing the path of the segment to create using the schema names of the loops and segments, like /N1Loop1/N1.
8. Once you are done with the segment, call EndSegment.
9. Once you are done with the transaction, call CreateTransactionFooter.
10. Once you are done with the functional group, call CreateFunctionalGroupFooter.
11. Once the interchange is complete, call CreateInterchangeFooter.

Example EDIFACTWriter Code:

EDIWriter1.StartInterchangeHeader("D98B"); //Complex Element, two components EDIWriter1.StartElement(); EDIWriter1.WriteComponentString("UNOB"); EDIWriter1.WriteComponentString("1"); EDIWriter1.EndElement(); //Skip a value for this element EDIWriter1.SkipElement(); //Basic element EDIWriter1.WriteElementString("7654323"); ... EDIWriter1.StartFunctionalGroupHeader(); ... EDIWriter1.StartTransactionHeader("APERAK"); //Complex Element, repeated element EDIWriter1.StartElement(); EDIWriter1.WriteComponentString("UNH1"); EDIWriter1.RepeatElement(); EDIWriter1.WriteComponentString("UNH2"); EDIWriter1.EndElement(); ... //Segment and its data EDIWriter1.StartSegment("BGM"); EDIWriter1.StartElement(); EDIWriter1.WriteComponentString("C00"); EDIWriter1.EndElement(); EDIWriter1.StartElement(); EDIWriter1.WriteComponentString("C10601"); EDIWriter1.EndElement(); EDIWriter1.EndSegment(); ... CreateTransactionFooter(); CreateFunctionalGroupFooter(); CreateInterchangeFooter();

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

FileWriteMode Property (TRADACOMSWriter Class)

Controls how the output file is opened.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileWriteMode();
int SetFileWriteMode(int iFileWriteMode);

Unicode (Windows)
INT GetFileWriteMode();
INT SetFileWriteMode(INT iFileWriteMode);

FWM_CREATE(0), 
FWM_OVERWRITE(1), 
FWM_APPEND(2)

int ipworkseditranslator_tradacomswriter_getfilewritemode(void* lpObj);
int ipworkseditranslator_tradacomswriter_setfilewritemode(void* lpObj, int iFileWriteMode);

int GetFileWriteMode();
int SetFileWriteMode(int iFileWriteMode);

Default Value

0

Remarks

This property controls how the component will open the output file specified in OutputFile. Possible values are:

Data Type

Integer

OutputData Property (TRADACOMSWriter Class)

Contains the output data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputData(char* &lpOutputData, int &lenOutputData);

Unicode (Windows)
INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);

int ipworkseditranslator_tradacomswriter_getoutputdata(void* lpObj, char** lpOutputData, int* lenOutputData);

QByteArray GetOutputData();

Default Value

""

Remarks

This property will be populated with the contents of the EDI data as output by the class when no OutputFile has been specified and SetOutputStream has not been called with a valid output stream.

This property is read-only.

Data Type

Binary String

OutputFile Property (TRADACOMSWriter Class)

Specifies the name of the EDI file to write to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* ipworkseditranslator_tradacomswriter_getoutputfile(void* lpObj);
int ipworkseditranslator_tradacomswriter_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

Set OutputFile before calling the StartInterchangeHeader method to write an EDI interchange to a file on disk.

Data Type

String

SchemaFormat Property (TRADACOMSWriter Class)

The format of the schema file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaFormat();
int SetSchemaFormat(int iSchemaFormat);

Unicode (Windows)
INT GetSchemaFormat();
INT SetSchemaFormat(INT iSchemaFormat);

SCHEMA_AUTOMATIC(0), 
SCHEMA_BINARY(1), 
SCHEMA_BIZ_TALK(2), 
SCHEMA_SEF(3), 
SCHEMA_BOTS(4), 
SCHEMA_ALTOVA(5), 
SCHEMA_JSON(6)

int ipworkseditranslator_tradacomswriter_getschemaformat(void* lpObj);
int ipworkseditranslator_tradacomswriter_setschemaformat(void* lpObj, int iSchemaFormat);

int GetSchemaFormat();
int SetSchemaFormat(int iSchemaFormat);

Default Value

0

Remarks

Set SchemaFormat before calling the LoadSchema method to specify the loading schema format.

The following schema formats are supported:

Data Type

Integer

Suffix Property (TRADACOMSWriter Class)

What to append after each segment delimiter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSuffix();
int SetSuffix(int iSuffix);

Unicode (Windows)
INT GetSuffix();
INT SetSuffix(INT iSuffix);

SUFFIX_NONE(0), 
SUFFIX_CR(1), 
SUFFIX_LF(2), 
SUFFIX_CRLF(3)

int ipworkseditranslator_tradacomswriter_getsuffix(void* lpObj);
int ipworkseditranslator_tradacomswriter_setsuffix(void* lpObj, int iSuffix);

int GetSuffix();
int SetSuffix(int iSuffix);

Default Value

0

Remarks

If Suffix is different from suffixNone, trailing (suffix) characters are appended after each segment delimiter. This is useful if you want to have a carriage return/line feed after each segment to make the document more readable.

This property is not available at design time.

Data Type

Integer

CompileSchema Method (TRADACOMSWriter Class)

Compiles an existing XSD schema into an optimized binary representation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CompileSchema(const char* lpszXsdSchema, const char* lpszBinSchema);

Unicode (Windows)
INT CompileSchema(LPCWSTR lpszXsdSchema, LPCWSTR lpszBinSchema);

int ipworkseditranslator_tradacomswriter_compileschema(void* lpObj, const char* lpszXsdSchema, const char* lpszBinSchema);

int CompileSchema(const QString& qsXsdSchema, const QString& qsBinSchema);

Remarks

This method parses XsdSchema and generates an optimized binary representation that is saved into the path referenced by BinSchema. Binary schemas are smaller and require less resources when loading later using LoadSchema

If the schema file does not exists or cannot be parsed as an EDI schema, the component throws an exception.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (TRADACOMSWriter Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkseditranslator_tradacomswriter_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateFunctionalGroupFooter Method (TRADACOMSWriter Class)

Closes the current functional group by writing its footer segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateFunctionalGroupFooter();

Unicode (Windows)
INT CreateFunctionalGroupFooter();

int ipworkseditranslator_tradacomswriter_createfunctionalgroupfooter(void* lpObj);

int CreateFunctionalGroupFooter();

Remarks

The CreateFunctionalGroupFooter method will write any existing segments to the output stream and then generate and write the functional group closing segment (GE or UNE). If there is an open transaction set, CreateFunctionalGroupFooter will first call CreateTransactionFooter to close it. If there is no functional group open, an exception will be thrown.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateInterchangeFooter Method (TRADACOMSWriter Class)

Closes the current interchange by writing its footer segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateInterchangeFooter();

Unicode (Windows)
INT CreateInterchangeFooter();

int ipworkseditranslator_tradacomswriter_createinterchangefooter(void* lpObj);

int CreateInterchangeFooter();

Remarks

The CreateInterchangeFooter method will write any existing segments to the output stream and then generate and write the interchange closing segment (IEA or UNZ). If there is an open transaction set, CreateInterchangeFooter will first call CreateTransactionFooter to close it. If there is an open functional group, CreateInterchangeFooter will first call CreateFunctionalGroupFooter to close it. If there is no interchange open, an exception will be thrown.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateTransactionFooter Method (TRADACOMSWriter Class)

Closes the current transaction set by writing its footer segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateTransactionFooter();

Unicode (Windows)
INT CreateTransactionFooter();

int ipworkseditranslator_tradacomswriter_createtransactionfooter(void* lpObj);

int CreateTransactionFooter();

Remarks

The CreateTransactionFooter method will write any existing segments to the output stream and then generate and write the transaction set closing segment (SE or UNT). If there are no open transaction sets, an exception will be thrown.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DisplaySchemaInfo Method (TRADACOMSWriter Class)

Returns a string showing the structure of the schema defining the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DisplaySchemaInfo();

Unicode (Windows)
LPWSTR DisplaySchemaInfo();

char* ipworkseditranslator_tradacomswriter_displayschemainfo(void* lpObj);

QString DisplaySchemaInfo();

Remarks

After calling LoadSchema this may be called to obtain information about the structure of the schema defining the document. If the desired XPath is not known this helps determine the structure so that the correct XPath can be built.

Note: A valid schema must be loaded via LoadSchema.

For instance: Console.WriteLine(component.DisplaySchemaInfo()); Will output text like:

UNH[0,1]
  BGM[0,1]
  DTM[0,35]
  PAI[0,1]
  ALI[0,5]
  IMD[0,1]
  FTX[0,10]
  LOC[0,10]
  GIS[0,10]
  DGS[0,1]
  RFFLoop1[0,99]
    RFF[0,1]
    DTM_2[0,5]
    GIR[0,5]
    LOC_2[0,2]
    MEA[0,5]
    QTY[0,2]
    FTX_2[0,5]
    MOA[0,2]
  NADLoop1[0,99]
    NAD[0,1]
    LOC_3[0,25]
    FII[0,5]
    RFFLoop2[0,9999]
      RFF_2[0,1]
      DTM_3[0,5]
    DOCLoop1[0,5]
      DOC[0,1]
      DTM_4[0,5]
    CTALoop1[0,5]
      CTA[0,1]
      COM[0,5]
  TAXLoop1[0,5]
    TAX[0,1]
    MOA_2[0,1]
    LOC_4[0,5]
  CUXLoop1[0,5]
    CUX[0,1]
    DTM_5[0,5]
  PATLoop1[0,10]
    PAT[0,1]
    DTM_6[0,5]
    PCD[0,1]
    MOA_3[0,1]
    PAI_2[0,1]
    FII_2[0,1]
  TDTLoop1[0,10]
    TDT[0,1]
    TSR[0,1]
    LOCLoop1[0,10]
      LOC_5[0,1]
      DTM_7[0,5]
    RFFLoop3[0,9999]
      RFF_3[0,1]
      DTM_8[0,5]
  TODLoop1[0,5]
    TOD[0,1]
    LOC_6[0,2]
  PACLoop1[0,1000]
    PAC[0,1]
    MEA_2[0,5]
    EQD[0,1]
    PCILoop1[0,5]
      PCI[0,1]
      RFF_4[0,1]
      DTM_9[0,5]
      GIN[0,5]
  ALCLoop1[0,9999]
    ALC[0,1]
    ALI_2[0,5]
    FTX_3[0,1]
    RFFLoop4[0,5]
      RFF_5[0,1]
      DTM_10[0,5]
    QTYLoop1[0,1]
      QTY_2[0,1]
      RNG[0,1]
    PCDLoop1[0,1]
      PCD_2[0,1]
      RNG_2[0,1]
    MOALoop1[0,2]
      MOA_4[0,1]
      RNG_3[0,1]
      CUX_2[0,1]
      DTM_11[0,1]
    RTELoop1[0,1]
      RTE[0,1]
      RNG_4[0,1]
    TAXLoop2[0,5]
      TAX_2[0,1]
      MOA_5[0,1]
  RCSLoop1[0,100]
    RCS[0,1]
    RFF_6[0,5]
    DTM_12[0,5]
    FTX_4[0,5]
  AJTLoop1[0,1]
    AJT[0,1]
    FTX_5[0,5]
  INPLoop1[0,1]
    INP[0,1]
    FTX_6[0,5]
  LINLoop1[0,9999999]
    LIN[0,1]
    PIA[0,25]
    IMD_2[0,10]
    MEA_3[0,5]
    QTY_3[0,5]
    PCD_3[0,1]
    ALI_3[0,5]
    DTM_13[0,35]
    GIN_2[0,1000]
    GIR_2[0,1000]
    QVR[0,1]
    EQD_2[0,1]
    FTX_7[0,5]
    DGS_2[0,1]
    MOALoop2[0,10]
      MOA_6[0,1]
      CUX_3[0,1]
    PATLoop2[0,10]
      PAT_2[0,1]
      DTM_14[0,5]
      PCD_4[0,1]
      MOA_7[0,1]
    PRILoop1[0,25]
      PRI[0,1]
      CUX_4[0,1]
      APR[0,1]
      RNG_5[0,1]
      DTM_15[0,5]
    RFFLoop5[0,10]
      RFF_7[0,1]
      DTM_16[0,5]
    PACLoop2[0,10]
      PAC_2[0,1]
      MEA_4[0,10]
      EQD_3[0,1]
      PCILoop2[0,10]
        PCI_2[0,1]
        RFF_8[0,1]
        DTM_17[0,5]
        GIN_3[0,10]
    LOCLoop2[0,9999]
      LOC_7[0,1]
      QTY_4[0,100]
      DTM_18[0,5]
    TAXLoop3[0,99]
      TAX_3[0,1]
      MOA_8[0,1]
      LOC_8[0,5]
    NADLoop2[0,99]
      NAD_2[0,1]
      LOC_9[0,5]
      RFFLoop6[0,5]
        RFF_9[0,1]
        DTM_19[0,5]
      DOCLoop2[0,5]
        DOC_2[0,1]
        DTM_20[0,5]
      CTALoop2[0,5]
        CTA_2[0,1]
        COM_2[0,5]
    ALCLoop2[0,30]
      ALC_2[0,1]
      ALI_4[0,5]
      DTM_21[0,5]
      FTX_8[0,1]
      QTYLoop2[0,1]
        QTY_5[0,1]
        RNG_6[0,1]
      PCDLoop2[0,1]
        PCD_5[0,1]
        RNG_7[0,1]
      MOALoop3[0,2]
        MOA_9[0,1]
        RNG_8[0,1]
        CUX_5[0,1]
        DTM_22[0,1]
      RTELoop2[0,1]
        RTE_2[0,1]
        RNG_9[0,1]
      TAXLoop4[0,5]
        TAX_4[0,1]
        MOA_10[0,1]
    TDTLoop2[0,10]
      TDT_2[0,1]
      LOCLoop3[0,10]
        LOC_10[0,1]
        DTM_23[0,5]
    TODLoop2[0,5]
      TOD_2[0,1]
      LOC_11[0,2]
    RCSLoop2[0,100]
      RCS_2[0,1]
      RFF_10[0,5]
      DTM_24[0,5]
      FTX_9[0,5]
    GISLoop1[0,10]
      GIS_2[0,1]
      RFF_11[0,1]
      DTM_25[0,5]
      GIR_3[0,5]
      LOC_12[0,2]
      MEA_5[0,5]
      QTY_6[0,2]
      FTX_10[0,5]
      MOA_11[0,2]
  UNS[0,1]
  CNT[0,10]
  MOALoop4[0,100]
    MOA_12[0,1]
    RFFLoop7[0,1]
      RFF_12[0,1]
      DTM_26[0,5]
  TAXLoop5[0,10]
    TAX_5[0,1]
    MOA_13[0,2]
  ALCLoop3[0,15]
    ALC_3[0,1]
    ALI_5[0,1]
    MOA_14[0,2]
    FTX_11[0,1]
  UNT[0,1]

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

EndElement Method (TRADACOMSWriter Class)

Finishes the current composite data element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EndElement();

Unicode (Windows)
INT EndElement();

int ipworkseditranslator_tradacomswriter_endelement(void* lpObj);

int EndElement();

Remarks

Call EndElement once you've written all components in an element started with StartElement. You should not call this if you wrote a simple element using WriteElementString

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EndSegment Method (TRADACOMSWriter Class)

Ends writing the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EndSegment();

Unicode (Windows)
INT EndSegment();

int ipworkseditranslator_tradacomswriter_endsegment(void* lpObj);

int EndSegment();

Remarks

EndSegment terminates writing the current segment and flushes it to the output stream/file.

You should call EndSegment to close a segment started with StartSegment, StartInterchangeHeader, StartFunctionalGroupHeader or StartTransactionHeader.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Flush Method (TRADACOMSWriter Class)

Forces any pending segments to be written to the output stream without closing it.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Flush();

Unicode (Windows)
INT Flush();

int ipworkseditranslator_tradacomswriter_flush(void* lpObj);

int Flush();

Remarks

The Flush method forces the component to write the last created segment to the output stream and then flush the output stream.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

LoadSchema Method (TRADACOMSWriter Class)

Loads a schema file describing a Transaction Set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadSchema(const char* lpszFileName);

Unicode (Windows)
INT LoadSchema(LPCWSTR lpszFileName);

int ipworkseditranslator_tradacomswriter_loadschema(void* lpObj, const char* lpszFileName);

int LoadSchema(const QString& qsFileName);

Remarks

This method parses the File and loads it into an internal schema list. The class will attempt to automatically detect the SchemaFormat.

If the schema file does not exist or cannot be parsed as an EDI schema, the class fails with an error.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RepeatElement Method (TRADACOMSWriter Class)

Adds a new repetition to the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RepeatElement();

Unicode (Windows)
INT RepeatElement();

int ipworkseditranslator_tradacomswriter_repeatelement(void* lpObj);

int RepeatElement();

Remarks

RepeatElement is used to write repeated data elements in supporting version of X12 or EDIFACT. To use it, first write the first repetition of the simple or composite data element and then call RepeatElement to repeat it, then write again.

Example: Repeating a simple data element: EDIWriter writer = new EDIWriter(); ... writer.StartSegment("Tag"); ... writer.WriteElementString("R1_1"); writer.RepeatElement(); writer.WriteElementString("R1_2"); writer.RepeatElement(); writer.WriteElementString("R1_3"); ... writer.EndSegment();

Example: Repeating a composite data element: EDIWriter writer = new EDIWriter(); ... writer.StartSegment("Tag"); ... writer.StartElement(); writer.WriteComponentString("C1_1"); writer.WriteComponentString("C2_1"); writer.RepeatElement(); writer.WriteComponentString("C1_2"); writer.WriteComponentString("C2_2"); writer.RepeatElement(); writer.WriteComponentString("C1_3"); writer.EndElement(); ... writer.EndSegment();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (TRADACOMSWriter Class)

Resets the state of the control.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkseditranslator_tradacomswriter_reset(void* lpObj);

int Reset();

Remarks

Resets the state of the writer. If a document has been partially written already, it will not be closed correctly and the write process will be aborted.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SkipComponent Method (TRADACOMSWriter Class)

Moves to the next sub-element in the current composite element in the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SkipComponent();

Unicode (Windows)
INT SkipComponent();

int ipworkseditranslator_tradacomswriter_skipcomponent(void* lpObj);

int SkipComponent();

Remarks

SkipComponent can be used to avoid providing a value for the current sub-element in the opened composite element within the current segment.

If the sub-element already has a value (such as one provided by default by the class), said value will not be overwritten.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SkipElement Method (TRADACOMSWriter Class)

Moves to the next data element in the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SkipElement();

Unicode (Windows)
INT SkipElement();

int ipworkseditranslator_tradacomswriter_skipelement(void* lpObj);

int SkipElement();

Remarks

SkipElement can be used to avoid providing a value for the current element in the current segment.

If the element already has a value (such as one provided by default by the class), said value will not be overwritten.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartElement Method (TRADACOMSWriter Class)

Starts a new EDI composite data element on the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartElement();

Unicode (Windows)
INT StartElement();

int ipworkseditranslator_tradacomswriter_startelement(void* lpObj);

int StartElement();

Remarks

When called, a new composite data element is created in the current segment. You can then call WriteComponentString one or more times to write the individual components or subelements that make up this composite.

Call EndElement once you've written all components in this element.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartFunctionalGroupHeader Method (TRADACOMSWriter Class)

Creates a new EDI functional group header segment on the current document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartFunctionalGroupHeader();

Unicode (Windows)
INT StartFunctionalGroupHeader();

int ipworkseditranslator_tradacomswriter_startfunctionalgroupheader(void* lpObj);

int StartFunctionalGroupHeader();

Remarks

When called, a new functional group start (GS or UNG) segment is created and set as the current segment. You should then set the values on said segment before adding a new transaction set within the document.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartInterchangeHeader Method (TRADACOMSWriter Class)

Creates a new EDI Interchange header segment on the current document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartInterchangeHeader(const char* lpszVersion);

Unicode (Windows)
INT StartInterchangeHeader(LPCWSTR lpszVersion);

int ipworkseditranslator_tradacomswriter_startinterchangeheader(void* lpObj, const char* lpszVersion);

int StartInterchangeHeader(const QString& qsVersion);

Remarks

When called, a new interchange start (ISA or UNB) segment is created and set as the current segment. You should then set the values on said segment before creating a functional group or a new transaction set within the document.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartSegment Method (TRADACOMSWriter Class)

Creates a new EDI data segment on the current document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartSegment(const char* lpszSegmentType);

Unicode (Windows)
INT StartSegment(LPCWSTR lpszSegmentType);

int ipworkseditranslator_tradacomswriter_startsegment(void* lpObj, const char* lpszSegmentType);

int StartSegment(const QString& qsSegmentType);

Remarks

When called, a new data segment is created in the current transaction and set as the current segment. You can then set the values on said segment. Creating a new data segment automatically writes the previous current segment to the output stream.

The SegmentType argument specifies the type of data segment to create, using an XPath-like syntax, based on the transaction set schema. For example, to create a new N1 segment on the first N1 loop, specify "/N1Loop1/N1".

It's important to realize that segments must be created in the same order they should appear on the target EDI document. The EDIWriter component doesn't automatically enforce ordering rules, nor does it force the document to reorder segments in loops automatically.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartTransactionHeader Method (TRADACOMSWriter Class)

Creates a new EDI transaction set header on the current document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartTransactionHeader(const char* lpszCode);

Unicode (Windows)
INT StartTransactionHeader(LPCWSTR lpszCode);

int ipworkseditranslator_tradacomswriter_starttransactionheader(void* lpObj, const char* lpszCode);

int StartTransactionHeader(const QString& qsCode);

Remarks

When called, a new transaction set start (ST or UNH) segment is created and set as the current segment. You should then set the values on said segment before adding creating transaction data segments.

The Code argument should specify the transaction code you want to create (for example, "850" or "INVOIC"). This value, together with the EDI specification and the version provided in the StartInterchangeHeader method are used to locate a matching transaction set schema on the components schema cache. You must make sure that a corresponding schema has been successfully loaded into the component by using the LoadSchema method before trying to call StartTransactionHeader.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

WriteComponentString Method (TRADACOMSWriter Class)

Sets the value of the next class within the current element in the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int WriteComponentString(const char* lpszValue);

Unicode (Windows)
INT WriteComponentString(LPCWSTR lpszValue);

int ipworkseditranslator_tradacomswriter_writecomponentstring(void* lpObj, const char* lpszValue);

int WriteComponentString(const QString& qsValue);

Remarks

Use the WriteComponentString method to specify a value for an individual component within a composite data element.

To write an entire composite data element, first call the StartElement method, then do one or more calls to WriteComponentString. Finish the composite element by calling the EndElement method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

WriteElementString Method (TRADACOMSWriter Class)

Sets a value of the next element in the current segment to a simple value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int WriteElementString(const char* lpszValue);

Unicode (Windows)
INT WriteElementString(LPCWSTR lpszValue);

int ipworkseditranslator_tradacomswriter_writeelementstring(void* lpObj, const char* lpszValue);

int WriteElementString(const QString& qsValue);

Remarks

Use the WriteElementString method to specify a value for the next data element with simple content on the current segment.

To write a composite data element, even if it has a single sub-element, use the StartElement and WriteComponentString methods instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

WriteTransaction Method (TRADACOMSWriter Class)

Writes an entire transaction to the output.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int WriteTransaction(const char* lpszValue);

Unicode (Windows)
INT WriteTransaction(LPCWSTR lpszValue);

int ipworkseditranslator_tradacomswriter_writetransaction(void* lpObj, const char* lpszValue);

int WriteTransaction(const QString& qsValue);

Remarks

Use the WriteTransaction method when you have generated a complete transaction outside of the class and want to include it in the document being created by this instance.

No validation is done on the contents of the Value parameter. You must ensure the transaction data is valid and matches the same conventions (delimiters, etc) being used in this document.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (TRADACOMSWriter Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(TRADACOMSWriterErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} TRADACOMSWriterErrorEventParams;


Unicode (Windows)
virtual INT FireError(TRADACOMSWriterErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} TRADACOMSWriterErrorEventParams;

#define EID_TRADACOMSWRITER_ERROR 1

virtual INT IPWORKSEDITRANSLATOR_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class TRADACOMSWriterErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(TRADACOMSWriterErrorEventParams *e);

// Or, subclass TRADACOMSWriter and override this emitter function.
virtual int FireError(TRADACOMSWriterErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Output Event (TRADACOMSWriter Class)

Fires whenever a segment is complete.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireOutput(TRADACOMSWriterOutputEventParams *e);

typedef struct {
  const char *OutputData;
  int lenOutputData;
  int reserved;
} TRADACOMSWriterOutputEventParams;


Unicode (Windows)
virtual INT FireOutput(TRADACOMSWriterOutputEventParams *e);

typedef struct {
  LPCSTR OutputData;
  INT lenOutputData;
  INT reserved;
} TRADACOMSWriterOutputEventParams;

#define EID_TRADACOMSWRITER_OUTPUT 2

virtual INT IPWORKSEDITRANSLATOR_CALL FireOutput(LPSTR &lpOutputData, INT &lenOutputData);

class TRADACOMSWriterOutputEventParams {
public:
  const QByteArray &OutputData();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Output(TRADACOMSWriterOutputEventParams *e);

// Or, subclass TRADACOMSWriter and override this emitter function.
virtual int FireOutput(TRADACOMSWriterOutputEventParams *e) {...}

Remarks

The Output event will fire when the writer completes a new segment and writes data to the output stream or buffer. The Data parameter contains the data bytes.

Warning Event (TRADACOMSWriter Class)

Fires whenever a validation warning is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWarning(TRADACOMSWriterWarningEventParams *e);

typedef struct {
  int WarnCode;
  const char *Message;
  int SegmentNumber;
  const char *SegmentTag;
  const char *SegmentErrorCode;
  const char *ElementErrorCode;
  int ElementPosition;
  int reserved;
} TRADACOMSWriterWarningEventParams;


Unicode (Windows)
virtual INT FireWarning(TRADACOMSWriterWarningEventParams *e);

typedef struct {
  INT WarnCode;
  LPCWSTR Message;
  INT SegmentNumber;
  LPCWSTR SegmentTag;
  LPCWSTR SegmentErrorCode;
  LPCWSTR ElementErrorCode;
  INT ElementPosition;
  INT reserved;
} TRADACOMSWriterWarningEventParams;

#define EID_TRADACOMSWRITER_WARNING 3

virtual INT IPWORKSEDITRANSLATOR_CALL FireWarning(INT &iWarnCode, LPSTR &lpszMessage, INT &iSegmentNumber, LPSTR &lpszSegmentTag, LPSTR &lpszSegmentErrorCode, LPSTR &lpszElementErrorCode, INT &iElementPosition);

class TRADACOMSWriterWarningEventParams {
public:
  int WarnCode();

  const QString &Message();

  int SegmentNumber();

  const QString &SegmentTag();

  const QString &SegmentErrorCode();

  const QString &ElementErrorCode();

  int ElementPosition();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Warning(TRADACOMSWriterWarningEventParams *e);

// Or, subclass TRADACOMSWriter and override this emitter function.
virtual int FireWarning(TRADACOMSWriterWarningEventParams *e) {...}

Remarks

The Warning event will fire if a validation error is encountered when writing a new segment to the output document. The WarnCode parameter contains the type of warning encountered. Message is a textual description of the problem. SegmentNumber is the index of the segment where the problem was found.

Config Settings (TRADACOMSWriter Class)

TRADACOMSWriter Config Settings

Base Config Settings

Trappable Errors (TRADACOMSWriter Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

TRADACOMSWriter Errors