X12Writer Class

Properties   Methods   Events   Config Settings   Errors  

The X12Writer class generates X12 documents with a clear, straightforward API.

Syntax

X12Writer

Remarks

The class allows you to create an EDI document from scratch, 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, or check the OutputData property after writing.
3. Create a new interchange start segment by setting the fields of the Interchange property and call the StartInterchange method. Once the interchange is complete, call EndInterchange to add the interchange footer.
4. If you want to create a functional group, set the fields of the FunctionalGroup property and then call the StartFunctionalGroup. Once all the transactions in the group have been created, call EndFunctionalGroup to add a footer for the group.
5. To start a transaction, call the StartTransactionSet method. Once all segments have been added, call EndTransactionSet to add a footer to the transaction.
6. To begin a segment, call the StartSegment method and pass in the tag for the segment. Once all the elements in the segment have been added, call EndSegment to add the segment terminator.
7. To write a basic element to the current segment, call the WriteElement method.
8. To write a composite element, call the StartCompositeElement method, then call the WriteComponent method for each component, and finally call EndCompositeElement to end the element.

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.

Delimiters Property (X12Writer Class)

Contains the delimiters for the EDI Document.

Syntax

• C++
• C
• Qt

EDISDKX12Delimiters* GetDelimiters();

char* edisdk_x12writer_getdelimitercomponent(void* lpObj);
int edisdk_x12writer_setdelimitercomponent(void* lpObj, const char* lpszDelimiterComponent);

char* edisdk_x12writer_getdelimiterelement(void* lpObj);
int edisdk_x12writer_setdelimiterelement(void* lpObj, const char* lpszDelimiterElement);

char* edisdk_x12writer_getdelimiterrepetition(void* lpObj);
int edisdk_x12writer_setdelimiterrepetition(void* lpObj, const char* lpszDelimiterRepetition);

char* edisdk_x12writer_getdelimitersegment(void* lpObj);
int edisdk_x12writer_setdelimitersegment(void* lpObj, const char* lpszDelimiterSegment);

QString getDelimiterComponent();
int setDelimiterComponent(QString qsDelimiterComponent);

QString getDelimiterElement();
int setDelimiterElement(QString qsDelimiterElement);

QString getDelimiterRepetition();
int setDelimiterRepetition(QString qsDelimiterRepetition);

QString getDelimiterSegment();
int setDelimiterSegment(QString qsDelimiterSegment);

Remarks

This property contains the delimiters that will be used when writing the EDIFACT document. If the document uses delimiters other than the default, change the properties of this object to write the document correctly.

This property is read-only and not available at design time.

Data Type

EDISDKX12Delimiters

FileWriteMode Property (X12Writer Class)

Determines how the output file is opened for writing.

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 edisdk_x12writer_getfilewritemode(void* lpObj);
int edisdk_x12writer_setfilewritemode(void* lpObj, int iFileWriteMode);

int getFileWriteMode();
int setFileWriteMode(int iFileWriteMode);

Default Value

0

Remarks

When OutputFile is set, this property determines how the file will be opened.

This property is not available at design time.

Data Type

Integer

FunctionalGroup Property (X12Writer Class)

Contains the current functional group information for the EDI Document.

Syntax

• C++
• C
• Qt

EDISDKX12FunctionalGroup* GetFunctionalGroup();

char* edisdk_x12writer_getfgroupappreceivercode(void* lpObj);
int edisdk_x12writer_setfgroupappreceivercode(void* lpObj, const char* lpszFGroupAppReceiverCode);

char* edisdk_x12writer_getfgroupappsendercode(void* lpObj);
int edisdk_x12writer_setfgroupappsendercode(void* lpObj, const char* lpszFGroupAppSenderCode);

char* edisdk_x12writer_getfgroupdate(void* lpObj);
int edisdk_x12writer_setfgroupdate(void* lpObj, const char* lpszFGroupDate);

char* edisdk_x12writer_getfgroupfunctionalidentifiercode(void* lpObj);
int edisdk_x12writer_setfgroupfunctionalidentifiercode(void* lpObj, const char* lpszFGroupFunctionalIdentifierCode);

char* edisdk_x12writer_getfgroupgroupcontrolnum(void* lpObj);
int edisdk_x12writer_setfgroupgroupcontrolnum(void* lpObj, const char* lpszFGroupGroupControlNum);

char* edisdk_x12writer_getfgroupresponsibleagencycode(void* lpObj);
int edisdk_x12writer_setfgroupresponsibleagencycode(void* lpObj, const char* lpszFGroupResponsibleAgencyCode);

char* edisdk_x12writer_getfgrouptime(void* lpObj);
int edisdk_x12writer_setfgrouptime(void* lpObj, const char* lpszFGroupTime);

char* edisdk_x12writer_getfgroupversion(void* lpObj);
int edisdk_x12writer_setfgroupversion(void* lpObj, const char* lpszFGroupVersion);

QString getFGroupAppReceiverCode();
int setFGroupAppReceiverCode(QString qsFGroupAppReceiverCode);

QString getFGroupAppSenderCode();
int setFGroupAppSenderCode(QString qsFGroupAppSenderCode);

QString getFGroupDate();
int setFGroupDate(QString qsFGroupDate);

QString getFGroupFunctionalIdentifierCode();
int setFGroupFunctionalIdentifierCode(QString qsFGroupFunctionalIdentifierCode);

QString getFGroupGroupControlNum();
int setFGroupGroupControlNum(QString qsFGroupGroupControlNum);

QString getFGroupResponsibleAgencyCode();
int setFGroupResponsibleAgencyCode(QString qsFGroupResponsibleAgencyCode);

QString getFGroupTime();
int setFGroupTime(QString qsFGroupTime);

QString getFGroupVersion();
int setFGroupVersion(QString qsFGroupVersion);

Remarks

The functional group information is used when writing the functional group header (GS) and trailer (GE) segments. The properties of this object must be changed before calling StartFunctionalGroup to write the functional group correctly. After calling StartFunctionalGroup changing the properties of this object will change the values for the next functional group only.

This property is read-only and not available at design time.

Data Type

EDISDKX12FunctionalGroup

Interchange Property (X12Writer Class)

Contains the current interchange information for the EDI Document.

Syntax

• C++
• C
• Qt

EDISDKX12Interchange* GetInterchange();

char* edisdk_x12writer_getinterchangeackrequest(void* lpObj);
int edisdk_x12writer_setinterchangeackrequest(void* lpObj, const char* lpszInterchangeAckRequest);

char* edisdk_x12writer_getinterchangeauthorizationinfo(void* lpObj);
int edisdk_x12writer_setinterchangeauthorizationinfo(void* lpObj, const char* lpszInterchangeAuthorizationInfo);

char* edisdk_x12writer_getinterchangeauthorizationinfoqualifier(void* lpObj);
int edisdk_x12writer_setinterchangeauthorizationinfoqualifier(void* lpObj, const char* lpszInterchangeAuthorizationInfoQualifier);

char* edisdk_x12writer_getinterchangedate(void* lpObj);
int edisdk_x12writer_setinterchangedate(void* lpObj, const char* lpszInterchangeDate);

char* edisdk_x12writer_getinterchangeinterchangecontrolnum(void* lpObj);
int edisdk_x12writer_setinterchangeinterchangecontrolnum(void* lpObj, const char* lpszInterchangeInterchangeControlNum);

char* edisdk_x12writer_getinterchangeinterchangecontrolversionnum(void* lpObj);
int edisdk_x12writer_setinterchangeinterchangecontrolversionnum(void* lpObj, const char* lpszInterchangeInterchangeControlVersionNum);

char* edisdk_x12writer_getinterchangereceiverid(void* lpObj);
int edisdk_x12writer_setinterchangereceiverid(void* lpObj, const char* lpszInterchangeReceiverID);

char* edisdk_x12writer_getinterchangereceiveridqualifier(void* lpObj);
int edisdk_x12writer_setinterchangereceiveridqualifier(void* lpObj, const char* lpszInterchangeReceiverIDQualifier);

char* edisdk_x12writer_getinterchangesecurityinfo(void* lpObj);
int edisdk_x12writer_setinterchangesecurityinfo(void* lpObj, const char* lpszInterchangeSecurityInfo);

char* edisdk_x12writer_getinterchangesecurityinfoqualifier(void* lpObj);
int edisdk_x12writer_setinterchangesecurityinfoqualifier(void* lpObj, const char* lpszInterchangeSecurityInfoQualifier);

char* edisdk_x12writer_getinterchangesenderid(void* lpObj);
int edisdk_x12writer_setinterchangesenderid(void* lpObj, const char* lpszInterchangeSenderID);

char* edisdk_x12writer_getinterchangesenderidqualifier(void* lpObj);
int edisdk_x12writer_setinterchangesenderidqualifier(void* lpObj, const char* lpszInterchangeSenderIDQualifier);

char* edisdk_x12writer_getinterchangetime(void* lpObj);
int edisdk_x12writer_setinterchangetime(void* lpObj, const char* lpszInterchangeTime);

char* edisdk_x12writer_getinterchangeusageindicator(void* lpObj);
int edisdk_x12writer_setinterchangeusageindicator(void* lpObj, const char* lpszInterchangeUsageIndicator);

QString getInterchangeAckRequest();
int setInterchangeAckRequest(QString qsInterchangeAckRequest);

QString getInterchangeAuthorizationInfo();
int setInterchangeAuthorizationInfo(QString qsInterchangeAuthorizationInfo);

QString getInterchangeAuthorizationInfoQualifier();
int setInterchangeAuthorizationInfoQualifier(QString qsInterchangeAuthorizationInfoQualifier);

QString getInterchangeDate();
int setInterchangeDate(QString qsInterchangeDate);

QString getInterchangeInterchangeControlNum();
int setInterchangeInterchangeControlNum(QString qsInterchangeInterchangeControlNum);

QString getInterchangeInterchangeControlVersionNum();
int setInterchangeInterchangeControlVersionNum(QString qsInterchangeInterchangeControlVersionNum);

QString getInterchangeReceiverID();
int setInterchangeReceiverID(QString qsInterchangeReceiverID);

QString getInterchangeReceiverIDQualifier();
int setInterchangeReceiverIDQualifier(QString qsInterchangeReceiverIDQualifier);

QString getInterchangeSecurityInfo();
int setInterchangeSecurityInfo(QString qsInterchangeSecurityInfo);

QString getInterchangeSecurityInfoQualifier();
int setInterchangeSecurityInfoQualifier(QString qsInterchangeSecurityInfoQualifier);

QString getInterchangeSenderID();
int setInterchangeSenderID(QString qsInterchangeSenderID);

QString getInterchangeSenderIDQualifier();
int setInterchangeSenderIDQualifier(QString qsInterchangeSenderIDQualifier);

QString getInterchangeTime();
int setInterchangeTime(QString qsInterchangeTime);

QString getInterchangeUsageIndicator();
int setInterchangeUsageIndicator(QString qsInterchangeUsageIndicator);

Remarks

The interchange information is used when writing the interchange header (ISA) and trailer (IEA) segments. The properties of this object must be changed before calling StartInterchange to write the interchange correctly. After calling StartInterchange changing the properties of this object will change the values for the next interchange only.

This property is read-only and not available at design time.

Data Type

EDISDKX12Interchange

OutputData Property (X12Writer Class)

The output data that has been written so far.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputData();
int SetOutputData(const char* lpszOutputData);

Unicode (Windows)
LPWSTR GetOutputData();
INT SetOutputData(LPCWSTR lpszOutputData);

char* edisdk_x12writer_getoutputdata(void* lpObj);
int edisdk_x12writer_setoutputdata(void* lpObj, const char* lpszOutputData);

QString getOutputData();
int setOutputData(QString qsOutputData);

Default Value

""

Remarks

OutputData contains the entire EDI document that has been written so far. If writing to a file or stream, this property will be empty.

This property is not available at design time.

Data Type

String

OutputFile Property (X12Writer Class)

The name of the output file to which the EDI data will be written.

Syntax

• C++
• C
• Qt

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

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

char* edisdk_x12writer_getoutputfile(void* lpObj);
int edisdk_x12writer_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString getOutputFile();
int setOutputFile(QString qsOutputFile);

Default Value

""

Remarks

FileWriteMode property determines how the file is opened for writing. If OutputFile is empty, no file will be written and the OutputData property will contain the EDI data instead.

This property is not available at design time.

Data Type

String

SegmentSuffix Property (X12Writer Class)

The suffix that is appended to the end of a segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSegmentSuffix();
int SetSegmentSuffix(int iSegmentSuffix);

Unicode (Windows)
INT GetSegmentSuffix();
INT SetSegmentSuffix(INT iSegmentSuffix);

SS_NONE(0), 
SS_CR(1), 
SS_LF(2), 
SS_CRLF(3)

int edisdk_x12writer_getsegmentsuffix(void* lpObj);
int edisdk_x12writer_setsegmentsuffix(void* lpObj, int iSegmentSuffix);

int getSegmentSuffix();
int setSegmentSuffix(int iSegmentSuffix);

Default Value

0

Remarks

Possible values are:

This property is not available at design time.

Data Type

Integer

TransactionSet Property (X12Writer Class)

Contains the current transaction set information for the EDI Document.

Syntax

• C++
• C
• Qt

EDISDKX12TransactionSet* GetTransactionSet();

char* edisdk_x12writer_gettranssetimpconventionreference(void* lpObj);
int edisdk_x12writer_settranssetimpconventionreference(void* lpObj, const char* lpszTransSetImpConventionReference);

char* edisdk_x12writer_gettranssettransactionsetcontrolnum(void* lpObj);
int edisdk_x12writer_settranssettransactionsetcontrolnum(void* lpObj, const char* lpszTransSetTransactionSetControlNum);

char* edisdk_x12writer_gettranssettransactionsetidcode(void* lpObj);
int edisdk_x12writer_settranssettransactionsetidcode(void* lpObj, const char* lpszTransSetTransactionSetIDCode);

QString getTransSetImpConventionReference();
int setTransSetImpConventionReference(QString qsTransSetImpConventionReference);

QString getTransSetTransactionSetControlNum();
int setTransSetTransactionSetControlNum(QString qsTransSetTransactionSetControlNum);

QString getTransSetTransactionSetIDCode();
int setTransSetTransactionSetIDCode(QString qsTransSetTransactionSetIDCode);

Remarks

This property holds the current transaction set information for the EDI document. It is used by the StartTransactionSet method to create a new transaction set header. The properties of this object must be changed before calling StartTransactionSet to write the transaction set correctly. After calling StartTransactionSet changing the properties of this object will change the values for the next transaction set only.

This property is read-only and not available at design time.

Data Type

EDISDKX12TransactionSet

Close Method (X12Writer Class)

Closes the writer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int edisdk_x12writer_close(void* lpObj);

int close();

Remarks

Calling Close will close the writer and release any resources associated with it. After calling Close, the writer cannot be used unless it is re-initialized.

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 (X12Writer 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* edisdk_x12writer_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.

EndCompositeElement Method (X12Writer Class)

Closes the current composite element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EndCompositeElement();

Unicode (Windows)
INT EndCompositeElement();

int edisdk_x12writer_endcompositeelement(void* lpObj);

int endCompositeElement();

Remarks

Calling EndCompositeElement will close the current composite element. If no composite element is open, an error will be raised.

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.)

EndFunctionalGroup Method (X12Writer Class)

Closes the current functional group.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EndFunctionalGroup();

Unicode (Windows)
INT EndFunctionalGroup();

int edisdk_x12writer_endfunctionalgroup(void* lpObj);

int endFunctionalGroup();

Remarks

Calling EndFunctionalGroup will close the current functional group. If no functional group is open, an error will be raised. This method will also write the required FunctionalGroup Trailer (GE) segment to the output.

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.)

EndInterchange Method (X12Writer Class)

Closes the current interchange.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EndInterchange();

Unicode (Windows)
INT EndInterchange();

int edisdk_x12writer_endinterchange(void* lpObj);

int endInterchange();

Remarks

Calling EndInterchange will close the current interchange. If no interchange is open, an error will be raised. This method will also write the required Interchange Trailer (IEA) segment to the output.

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 (X12Writer Class)

Finish writing the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EndSegment();

Unicode (Windows)
INT EndSegment();

int edisdk_x12writer_endsegment(void* lpObj);

int endSegment();

Remarks

Calling EndSegment will finish writing the current segment. If no segment is open or if a composite element is still open an error will be raised. This method will also write the segment delimiter and segment suffix to the output.

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.)

EndTransactionSet Method (X12Writer Class)

Closes the current transaction set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EndTransactionSet();

Unicode (Windows)
INT EndTransactionSet();

int edisdk_x12writer_endtransactionset(void* lpObj);

int endTransactionSet();

Remarks

Calling this method will close the current transaction set. If no transaction set is open, an error will be raised. This method will also write the required Transaction Set Trailer (SE) segment to the output.

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 (X12Writer Class)

Resets all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int edisdk_x12writer_reset(void* lpObj);

int reset();

Remarks

This method resets all properties of the component to their default values as specified in the property definitions.

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.)

StartCompositeElement Method (X12Writer Class)

Starts a composite element within the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartCompositeElement();

Unicode (Windows)
INT StartCompositeElement();

int edisdk_x12writer_startcompositeelement(void* lpObj);

int startCompositeElement();

Remarks

This method starts a composite element within the current segment. The composite element can contain multiple component elements. The composite element is ended by calling the EndCompositeElement method. Component elements within the composite are added by calling the WriteComponent 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.)

StartFunctionalGroup Method (X12Writer Class)

Starts a new functional group in the EDI document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartFunctionalGroup();

Unicode (Windows)
INT StartFunctionalGroup();

int edisdk_x12writer_startfunctionalgroup(void* lpObj);

int startFunctionalGroup();

Remarks

This method starts a new functional group in the EDI document. The functional group fields must be set using the appropriate properties before calling this method. The functional group is ended by calling the EndFunctionalGroup method. The functional group header segment (GS) is written to the output when this method is called.

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.)

StartInterchange Method (X12Writer Class)

Starts a new interchange in the EDI document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartInterchange();

Unicode (Windows)
INT StartInterchange();

int edisdk_x12writer_startinterchange(void* lpObj);

int startInterchange();

Remarks

This method starts a new interchange in the EDI document. The interchange fields must be set using the appropriate properties before calling this method. The interchange is ended by calling the EndInterchange method. The interchange header segment (ISA) is written to the output when this method is called. If opening a new interchange would result in an invalid structure (for example, starting a new interchange before ending the previous one), an error will be raised.

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 (X12Writer Class)

Starts a new segment with the specified tag.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT StartSegment(LPCWSTR lpsztag);

int edisdk_x12writer_startsegment(void* lpObj, const char* lpsztag);

int startSegment(const QString& qstag);

Remarks

This method starts a new segment with the specified tag. The segment is ended by calling the EndSegment method. Element values within the segment are added by calling the WriteElement method. Composite elements can be added to the segment by calling the StartCompositeElement method. If starting a new segment would result in an invalid structure (for example, starting a new segment before ending the previous one), an error will be raised.

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.)

StartTransactionSet Method (X12Writer Class)

Starts a new transaction set in the EDI document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartTransactionSet();

Unicode (Windows)
INT StartTransactionSet();

int edisdk_x12writer_starttransactionset(void* lpObj);

int startTransactionSet();

Remarks

This method starts a new transaction set in the EDI document. The transaction set fields must be set using the appropriate properties before calling this method. The transaction set is ended by calling the EndTransactionSet method. The transaction set header segment (ST) is written to the output when this method is called. If opening a new transaction set would result in an invalid structure (for example, starting a new transaction set before ending the previous one), an error will be raised.

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.)

WriteComponent Method (X12Writer Class)

Writes a class element value to the current composite element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int WriteComponent(const char* lpszval);

Unicode (Windows)
INT WriteComponent(LPCWSTR lpszval);

int edisdk_x12writer_writecomponent(void* lpObj, const char* lpszval);

int writeComponent(const QString& qsval);

Remarks

This method writes a component element value to the current composite element. The composite element must be started by calling the StartCompositeElement method before calling this method. The composite element is ended by calling the EndCompositeElement method. If this method is called when not within a composite element, an error will be raised.

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.)

WriteElement Method (X12Writer Class)

Writes an element value to the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int WriteElement(const char* lpszval);

Unicode (Windows)
INT WriteElement(LPCWSTR lpszval);

int edisdk_x12writer_writeelement(void* lpObj, const char* lpszval);

int writeElement(const QString& qsval);

Remarks

This method writes an element value to the current segment. The segment must be started by calling the StartSegment method before calling this method. The segment is ended by calling the EndSegment method. If this method is called when not within a segment, an error will be raised.

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 (X12Writer Class)

Fires when an error occurs during message processing. Normally, the class fails with an error.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_X12WRITER_ERROR 1

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

class X12WriterErrorEventParams {
public:
  int errorCode();

  const QString &description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass X12Writer and override this emitter function.
virtual int fireError(X12WriterErrorEventParams *e) {...}
// Or, connect one or more slots to this signal.
void error(X12WriterErrorEventParams *e);

Remarks

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

ConnectionId is the associated client Id, 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 (X12Writer Class)

Fires when output data is written.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *Data;
  int lenData;
  int reserved;
} X12WriterOutputEventParams;


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

typedef struct {
  LPCSTR Data;
  INT lenData;
  INT reserved;
} X12WriterOutputEventParams;

#define EID_X12WRITER_OUTPUT 2

virtual INT EDISDK_CALL FireOutput(LPSTR &lpData, INT &lenData);

class X12WriterOutputEventParams {
public:
  const QByteArray &data();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass X12Writer and override this emitter function.
virtual int fireOutput(X12WriterOutputEventParams *e) {...}
// Or, connect one or more slots to this signal.
void output(X12WriterOutputEventParams *e);

Remarks

This event is fired when output data is written. The Data parameter contains the segment that was written.

X12Delimiters Type

The delimiters used in the X12 document.

Syntax

EDISDKX12Delimiters (declared in edisdk.h)

Remarks

This type contains fields specifying the various delimiters used within the X12 document.

• Component
• Element
• Repetition
• Segment

Fields

Constructors

X12Delimiters()

X12FunctionalGroup Type

A functional group of messages.

Syntax

EDISDKX12FunctionalGroup (declared in edisdk.h)

Remarks

This type represents a functional group of messages, with fields describing the values from the GS segment.

• AppReceiverCode
• AppSenderCode
• Date
• FunctionalIdentifierCode
• GroupControlNum
• ResponsibleAgencyCode
• Time
• Version

Fields

Constructors

X12FunctionalGroup()

X12Interchange Type

An interchange containing functional groups and transaction sets.

Syntax

EDISDKX12Interchange (declared in edisdk.h)

Remarks

This type represents an X12 interchange, with fields describing the values from the ISA segment.

• AckRequest
• AuthorizationInfo
• AuthorizationInfoQualifier
• Date
• InterchangeControlNum
• InterchangeControlVersionNum
• ReceiverID
• ReceiverIDQualifier
• SecurityInfo
• SecurityInfoQualifier
• SenderID
• SenderIDQualifier
• Time
• UsageIndicator

Fields

Constructors

X12Interchange()

X12TransactionSet Type

An X12 transaction set.

Syntax

EDISDKX12TransactionSet (declared in edisdk.h)

Remarks

This type represents an X12 transaction set, with fields describing the values from the ST segment.

• ImpConventionReference
• TransactionSetControlNum
• TransactionSetIDCode

Fields

Constructors

X12TransactionSet()

Config Settings (X12Writer Class)

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

X12Writer Errors