IPWorks EDI 2022 C++ Edition
Version 22.0 [Build 8369]

VDAWriter Class

Properties   Methods   Events   Config Settings   Errors  

The VDAWriter class is optimized for VDA documents, providing a simple way to create VDA documents.

Syntax

VDAWriter

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.

FileWriteModeControls how the output file is opened.
OutputDataContains the output data.
OutputFileSpecifies the name of the EDI file to write to.
SchemaFormatThe format of the schema file.
SuffixWhat to append after each segment delimiter.

Method List


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

CompileSchemaCompiles an existing XSD schema into an optimized binary representation.
ConfigSets or retrieves a configuration setting.
CreateFunctionalGroupFooterCloses the current functional group by writing its footer segment.
CreateInterchangeFooterCloses the current interchange by writing its footer segment.
CreateTransactionFooterCloses the current transaction set by writing its footer segment.
DisplaySchemaInfoReturns a string showing the structure of the schema defining the document.
EndElementFinishes the current composite data element.
EndSegmentEnds writing the current segment.
FlushForces any pending segments to be written to the output stream without closing it.
LoadSchemaLoads a schema file describing a Transaction Set.
RepeatElementAdds a new repetition to the current element.
ResetResets the state of the control.
SkipComponentMoves to the next sub-element in the current composite element in the current segment.
SkipElementMoves to the next data element in the current segment.
StartElementStarts a new EDI composite data element on the current segment.
StartFunctionalGroupHeaderCreates a new EDI functional group header segment on the current document.
StartInterchangeHeaderCreates a new EDI Interchange header segment on the current document.
StartSegmentCreates a new EDI data segment on the current document.
StartTransactionHeaderCreates a new EDI transaction set header on the current document.
WriteComponentStringSets the value of the next class within the current element in the current segment.
WriteElementStringSets a value of the next element in the current segment to a simple value.
WriteTransactionWrites an entire transaction to the output.

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.

ErrorInformation about errors during data delivery.
OutputFires whenever a segment is complete.
WarningFires whenever a validation warning is encountered.

Config Settings


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

ComponentDelimiterThe delimiter character to use to separate classes.
EdifactSyntaxVersionChanges the syntax version used for EDIFACT control segments.
ElementDelimiterThe delimiter character to use to separate data elements.
EncodingThe character encoding to be applied when reading and writing data.
IncludeUNAWhether to include the UNA segment in the output.
ReleaseCharThe character to use to escape delimiters within values.
RepetitionCharThe repetition character.
SegmentDelimiterThe delimiter character to use to separate segments.
StrictSchemaValidationSpecifies the behavior during schema validation.
TransactionOnlyIgnores interchange and functional group validation, allowing you to build the transaction body.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

FileWriteMode Property (VDAWriter Class)

Controls how the output file is opened.

Syntax

ANSI (Cross Platform)
int GetFileWriteMode();
int SetFileWriteMode(int iFileWriteMode); Unicode (Windows) INT GetFileWriteMode();
INT SetFileWriteMode(INT iFileWriteMode);

Possible Values

FWM_CREATE(0), 
FWM_OVERWRITE(1),
FWM_APPEND(2)
int ipworksedi_vdawriter_getfilewritemode(void* lpObj);
int ipworksedi_vdawriter_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:

fwmCreate (0)Always create a new file. If the file already exists, an error will be raised.
fwmOverwrite (1)If the output file already exists, it will be overwritten.
fwmAppend (2)If the output file already exists, data will be appended to it.

Data Type

Integer

OutputData Property (VDAWriter Class)

Contains the output data.

Syntax

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

Unicode (Windows)
INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);
int ipworksedi_vdawriter_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 (VDAWriter Class)

Specifies the name of the EDI file to write to.

Syntax

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* ipworksedi_vdawriter_getoutputfile(void* lpObj);
int ipworksedi_vdawriter_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 (VDAWriter Class)

The format of the schema file.

Syntax

ANSI (Cross Platform)
int GetSchemaFormat();
int SetSchemaFormat(int iSchemaFormat); Unicode (Windows) INT GetSchemaFormat();
INT SetSchemaFormat(INT iSchemaFormat);

Possible Values

SCHEMA_AUTOMATIC(0), 
SCHEMA_BINARY(1),
SCHEMA_BIZ_TALK(2),
SCHEMA_SEF(3),
SCHEMA_BOTS(4),
SCHEMA_ALTOVA(5),
SCHEMA_JSON(6)
int ipworksedi_vdawriter_getschemaformat(void* lpObj);
int ipworksedi_vdawriter_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:

0 (schemaAutomatic - default) The schema type is automatically determined based on file extension.
1 (schemaBinary) A binary schema that was previously compiled by calling CompileSchema.
2 (schemaBizTalk) BizTalk (XSD): http://msdn.microsoft.com/en-us/library/aa559426(v=BTS.70).aspx
3 (schemaSEF) TIBCO Standard Exchange Format (SEF): https://docs.tibco.com/products/tibco-foresight-edisim-6-18-0
5 (schemaAltova) Altova: http://www.altova.com/
6 (schemaJSON - recommended) ArcESB JSON: https://arc.cdata.com/

Data Type

Integer

Suffix Property (VDAWriter Class)

What to append after each segment delimiter.

Syntax

ANSI (Cross Platform)
int GetSuffix();
int SetSuffix(int iSuffix); Unicode (Windows) INT GetSuffix();
INT SetSuffix(INT iSuffix);

Possible Values

SUFFIX_NONE(0), 
SUFFIX_CR(1),
SUFFIX_LF(2),
SUFFIX_CRLF(3)
int ipworksedi_vdawriter_getsuffix(void* lpObj);
int ipworksedi_vdawriter_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 (VDAWriter Class)

Compiles an existing XSD schema into an optimized binary representation.

Syntax

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

Unicode (Windows)
INT CompileSchema(LPCWSTR lpszXsdSchema, LPCWSTR lpszBinSchema);
int ipworksedi_vdawriter_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 (VDAWriter Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksedi_vdawriter_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 (VDAWriter Class)

Closes the current functional group by writing its footer segment.

Syntax

ANSI (Cross Platform)
int CreateFunctionalGroupFooter();

Unicode (Windows)
INT CreateFunctionalGroupFooter();
int ipworksedi_vdawriter_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 (VDAWriter Class)

Closes the current interchange by writing its footer segment.

Syntax

ANSI (Cross Platform)
int CreateInterchangeFooter();

Unicode (Windows)
INT CreateInterchangeFooter();
int ipworksedi_vdawriter_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 (VDAWriter Class)

Closes the current transaction set by writing its footer segment.

Syntax

ANSI (Cross Platform)
int CreateTransactionFooter();

Unicode (Windows)
INT CreateTransactionFooter();
int ipworksedi_vdawriter_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 (VDAWriter Class)

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

Syntax

ANSI (Cross Platform)
char* DisplaySchemaInfo();

Unicode (Windows)
LPWSTR DisplaySchemaInfo();
char* ipworksedi_vdawriter_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:

  ST[0,1]
  BIG[0,1]
  NTE[0,100]
  CUR[0,1]
  REF[0,12]
  YNQ[0,10]
  PER[0,3]
  N1Loop1[0,200]
    N1[0,1]
    N2[0,2]
    N3[0,2]
    N4[0,1]
    REF_2[0,12]
    PER_2[0,3]
    DMG[0,1]
  ITD[0,999999]
  DTM[0,10]
  FOB[0,1]
  PID[0,200]
  MEA[0,40]
  PWK[0,25]
  PKG[0,25]
  L7[0,1]
  BAL[0,999999]
  INC[0,1]
  PAM[0,999999]
  LMLoop1[0,10]
    LM[0,1]
    LQ[0,100]
  N9Loop1[0,1]
    N9[0,1]
    MSG[0,10]
  V1Loop1[0,999999]
    V1[0,1]
    R4[0,999999]
    DTM_2[0,999999]
  FA1Loop1[0,999999]
    FA1[0,1]
    FA2[0,999999]
  IT1Loop1[0,200000]
    IT1[0,1]
    CRC[0,1]
    QTY[0,5]
    CUR_2[0,1]
    IT3[0,5]
    TXI[0,10]
    CTP[0,25]
    PAM_2[0,10]
    MEA_2[0,40]
    PIDLoop1[0,1000]
      PID_2[0,1]
      MEA_3[0,10]
    PWK_2[0,25]
    PKG_2[0,25]
    PO4[0,1]
    ITD_2[0,2]
    REF_3[0,999999]
    YNQ_2[0,10]
    PER_3[0,5]
    SDQ[0,500]
    DTM_3[0,10]
    CAD[0,999999]
    L7_2[0,999999]
    SR[0,1]
    SACLoop1[0,25]
      SAC[0,1]
      TXI_2[0,10]
    SLNLoop1[0,1000]
      SLN[0,1]
      DTM_4[0,1]
      REF_4[0,999999]
      PID_3[0,1000]
      SAC_2[0,25]
      TC2[0,2]
      TXI_3[0,10]
    N1Loop2[0,200]
      N1_2[0,1]
      N2_2[0,2]
      N3_2[0,2]
      N4_2[0,1]
      REF_5[0,12]
      PER_4[0,3]
      DMG_2[0,1]
    LMLoop2[0,10]
      LM_2[0,1]
      LQ_2[0,100]
    V1Loop2[0,999999]
      V1_2[0,1]
      R4_2[0,999999]
      DTM_5[0,999999]
    FA1Loop2[0,999999]
      FA1_2[0,1]
      FA2_2[0,999999]
  TDS[0,1]
  TXI_4[0,10]
  CAD_2[0,1]
  AMT[0,999999]
  SACLoop2[0,25]
    SAC_3[0,1]
    TXI_5[0,10]
  ISSLoop1[0,999999]
    ISS[0,1]
    PID_4[0,1]
  CTT[0,1]
  SE[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 (VDAWriter Class)

Finishes the current composite data element.

Syntax

ANSI (Cross Platform)
int EndElement();

Unicode (Windows)
INT EndElement();
int ipworksedi_vdawriter_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 (VDAWriter Class)

Ends writing the current segment.

Syntax

ANSI (Cross Platform)
int EndSegment();

Unicode (Windows)
INT EndSegment();
int ipworksedi_vdawriter_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 (VDAWriter Class)

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

Syntax

ANSI (Cross Platform)
int Flush();

Unicode (Windows)
INT Flush();
int ipworksedi_vdawriter_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 (VDAWriter Class)

Loads a schema file describing a Transaction Set.

Syntax

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

Unicode (Windows)
INT LoadSchema(LPCWSTR lpszFileName);
int ipworksedi_vdawriter_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 (VDAWriter Class)

Adds a new repetition to the current element.

Syntax

ANSI (Cross Platform)
int RepeatElement();

Unicode (Windows)
INT RepeatElement();
int ipworksedi_vdawriter_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 (VDAWriter Class)

Resets the state of the control.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int ipworksedi_vdawriter_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 (VDAWriter Class)

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

Syntax

ANSI (Cross Platform)
int SkipComponent();

Unicode (Windows)
INT SkipComponent();
int ipworksedi_vdawriter_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 (VDAWriter Class)

Moves to the next data element in the current segment.

Syntax

ANSI (Cross Platform)
int SkipElement();

Unicode (Windows)
INT SkipElement();
int ipworksedi_vdawriter_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 (VDAWriter Class)

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

Syntax

ANSI (Cross Platform)
int StartElement();

Unicode (Windows)
INT StartElement();
int ipworksedi_vdawriter_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 (VDAWriter Class)

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

Syntax

ANSI (Cross Platform)
int StartFunctionalGroupHeader();

Unicode (Windows)
INT StartFunctionalGroupHeader();
int ipworksedi_vdawriter_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 (VDAWriter Class)

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

Syntax

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

Unicode (Windows)
INT StartInterchangeHeader(LPCWSTR lpszVersion);
int ipworksedi_vdawriter_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 (VDAWriter Class)

Creates a new EDI data segment on the current document.

Syntax

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

Unicode (Windows)
INT StartSegment(LPCWSTR lpszSegmentType);
int ipworksedi_vdawriter_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 (VDAWriter Class)

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

Syntax

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

Unicode (Windows)
INT StartTransactionHeader(LPCWSTR lpszCode);
int ipworksedi_vdawriter_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 (VDAWriter Class)

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

Syntax

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

Unicode (Windows)
INT WriteComponentString(LPCWSTR lpszValue);
int ipworksedi_vdawriter_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 (VDAWriter Class)

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

Syntax

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

Unicode (Windows)
INT WriteElementString(LPCWSTR lpszValue);
int ipworksedi_vdawriter_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 (VDAWriter Class)

Writes an entire transaction to the output.

Syntax

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

Unicode (Windows)
INT WriteTransaction(LPCWSTR lpszValue);
int ipworksedi_vdawriter_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 (VDAWriter Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(VDAWriterErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } VDAWriterErrorEventParams;
Unicode (Windows) virtual INT FireError(VDAWriterErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } VDAWriterErrorEventParams;
#define EID_VDAWRITER_ERROR 1

virtual INT IPWORKSEDI_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class VDAWriterErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(VDAWriterErrorEventParams *e);
// Or, subclass VDAWriter and override this emitter function. virtual int FireError(VDAWriterErrorEventParams *e) {...}

Remarks

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

ErrorCode contains an error code and Description 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 (VDAWriter Class)

Fires whenever a segment is complete.

Syntax

ANSI (Cross Platform)
virtual int FireOutput(VDAWriterOutputEventParams *e);
typedef struct {
const char *OutputData; int lenOutputData; int reserved; } VDAWriterOutputEventParams;
Unicode (Windows) virtual INT FireOutput(VDAWriterOutputEventParams *e);
typedef struct {
LPCSTR OutputData; INT lenOutputData; INT reserved; } VDAWriterOutputEventParams;
#define EID_VDAWRITER_OUTPUT 2

virtual INT IPWORKSEDI_CALL FireOutput(LPSTR &lpOutputData, INT &lenOutputData);
class VDAWriterOutputEventParams {
public:
  const QByteArray &OutputData();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Output(VDAWriterOutputEventParams *e);
// Or, subclass VDAWriter and override this emitter function. virtual int FireOutput(VDAWriterOutputEventParams *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 (VDAWriter Class)

Fires whenever a validation warning is encountered.

Syntax

ANSI (Cross Platform)
virtual int FireWarning(VDAWriterWarningEventParams *e);
typedef struct {
int WarnCode;
const char *Message;
int SegmentNumber;
const char *SegmentTag;
const char *SegmentErrorCode;
const char *ElementErrorCode;
int ElementPosition; int reserved; } VDAWriterWarningEventParams;
Unicode (Windows) virtual INT FireWarning(VDAWriterWarningEventParams *e);
typedef struct {
INT WarnCode;
LPCWSTR Message;
INT SegmentNumber;
LPCWSTR SegmentTag;
LPCWSTR SegmentErrorCode;
LPCWSTR ElementErrorCode;
INT ElementPosition; INT reserved; } VDAWriterWarningEventParams;
#define EID_VDAWRITER_WARNING 3

virtual INT IPWORKSEDI_CALL FireWarning(INT &iWarnCode, LPSTR &lpszMessage, INT &iSegmentNumber, LPSTR &lpszSegmentTag, LPSTR &lpszSegmentErrorCode, LPSTR &lpszElementErrorCode, INT &iElementPosition);
class VDAWriterWarningEventParams {
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(VDAWriterWarningEventParams *e);
// Or, subclass VDAWriter and override this emitter function. virtual int FireWarning(VDAWriterWarningEventParams *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.

0 The component is not required but is present.
1 Invalid segment count.
2 Invalid transaction count.
3 Invalid group count.
4 Invalid interchange control number.
5 Invalid group control number.
6 Invalid transaction control number.
10 A required data element is missing.
11 Invalid field length.
12 Invalid field value.
13 A required component is missing.
14 The data element is not defined but is present.
30 Required segment is missing.
31 Required loop is missing.
32 Occurrences exceeds the schema defined limit.
33 Occurrences is less than the schema defined minimum.
40 Paired rule validation failed, the pair of elements must be present.
41 At least one of element is required, see message for list of elements.
42 Exclusion validation failed, only one of the elements can be present.
43 Conditional rule validation failed.
44 List conditional rule validation failed.
45 First then none validation failed. The presence of an element requires that other specific elements must not be present.
46 Only one or none of the elements can be present.

Config Settings (VDAWriter Class)

The class accepts one or more of the following configuration settings. Configuration 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.

VDAWriter Config Settings

ComponentDelimiter:   The delimiter character to use to separate components.

When set, this changes the default delimiter to use to separate components within a data element. The default value depends on the EDI specification being used. This should be set after setting EDIStandard. Setting EDIStandard resets the default delimiter value.

EdifactSyntaxVersion:   Changes the syntax version used for EDIFACT control segments.

Can be a number from 1 to 4. The default value is 1.

ElementDelimiter:   The delimiter character to use to separate data elements.

When set, this changes the default delimiter to use to separate data elements within a segment. The default value depends on the EDI specification being used.

Encoding:   The character encoding to be applied when reading and writing data.

If the data contains non-ASCII characters this setting should be specified so characters are properly preserved. This value should be set to a valid character set such as "UTF-8" or "ISO-8859-1".

IncludeUNA:   Whether to include the UNA segment in the output.

This setting determines whether the UNA segment is included in the EDIFACT output. If False, no Service String Advice (UNA) segment will be generated for EDIFACT interchanges. The default value is True.

ReleaseChar:   The character to use to escape delimiters within values.

When set, this changes the default escape character. The default value depends on the EDI specification being used.

RepetitionChar:   The repetition character.

When set, this changes the default repetition character. The default value depends on the EDI specification being used.

SegmentDelimiter:   The delimiter character to use to separate segments.

When set, this changes the default delimiter to use to separate segments within an EDI document. The default value depends on the EDI specification being used.

StrictSchemaValidation:   Specifies the behavior during schema validation.

This setting specifies what happens when performing schema validation and a validation warning occurs. By default this value is set to 1 (Warn) and the Warning event will fire, but processing will not stop. See the WarnCode parameter list in the Warning event for details about possible validation warnings. Possible values for this setting are:

0 (Ignore) All validation warnings will be ignored. Warning will not fire with warnings.
1 (Warn - default) The Warning event will fire with all validation warnings.
2 (Error) All validation warnings are treated as errors and will cause an exception. Processing will stop immediately.

TransactionOnly:   Ignores interchange and functional group validation, allowing you to build the transaction body.

When set to true, interchange and functional group headers will not be required. This allows building of the transaction level of an EDIFact document without specifying a document type.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (VDAWriter 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.

VDAWriter Errors

1000   Input/Output error
1001   No stream or file name were specified for the component
1002   Unexpected end of file (EOF).
1003   Segment not found.
1004   Segment not found in schema.
1005   Schema not found.
1010   Invalid Writer state.
1011   Segment does not have the specified element or component.
1044   Error while reading schema file.
1099   Unexpected error.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2022 C++ Edition - Version 22.0 [Build 8369]