AddRenamingRule Method

This method adds a renaming rule to define how an EDI element is renamed when translating to XML.

Syntax

ANSI (Cross Platform)
int AddRenamingRule(const char* lpszRule);

Unicode (Windows)
INT AddRenamingRule(LPCWSTR lpszRule);
- (void)addRenamingRule:(NSString*)rule;
#define MID_X12TRANSLATOR_ADDRENAMINGRULE 2

IPWORKSX12_EXTERNAL int IPWORKSX12_CALL IPWorksX12_X12Translator_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method adds a renaming rule. The rule defining how EDI elements are renamed when translating to XML. Renaming rules are optional.

The renaming rule defines how EDI elements are renamed when translating to XML or JSON. The format is: 

ediname:xmlanme
For instance: "UNH1:MsgRefNumber".

Note: Renaming rules are not required when converting from XML or JSON to EDI.

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.)
Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks X12 2020 C++ Edition - Version 20.0 [Build 8155]