RTF parsing
Data Structures | |
struct | A3DMkpRTFFieldData |
Structure used to parse RTF strings. More... | |
Functions | |
A3DStatus | A3DMkpRTFDelete (A3DVoid *pRTFData) |
delete RTF data created by A3DMkpRTFInit More... | |
A3DStatus | A3DMkpRTFFieldCreate (const A3DUTF8Char *pRTFString, A3DMkpRTFField **pRTFField) |
Initialize RTF data for parsing Previously A3DMkpRTFInit. More... | |
A3DStatus | A3DMkpRTFFieldDelete (const A3DMkpRTFField *pRTFField) |
delete RTF data created by A3DMkpRTFInit Previously A3DMkpRTFDelete. More... | |
A3DStatus | A3DMkpRTFFieldGet (const A3DMkpRTFField *pRTFField, A3DMkpRTFFieldData *pRTFFieldData) |
Get each independent field of a RTF data Previously A3DMkpRTFGetField. More... | |
A3DStatus | A3DMkpRTFGetField (A3DVoid *pRTFData, A3DRTFFieldData *pRTFField) |
Get each independent field of a RTF data. More... | |
A3DStatus | A3DMkpRTFInit (const A3DUTF8Char *pRTF, A3DVoid *&pRTFData) |
Initialize RTF data for parsing. More... | |
Detailed Description
Set of functions used to parse RTF strings.
RTF strings can be present in A3DMDFCFDraftingRowData, A3DMarkupGDTData, A3DMarkupRichTextData
- Sample code
- /* code to get each independent field of RTF string *//* pRTF_UTF8 is an RTF string* */A3DVoid* pRTF = NULL;{A3DRTFFieldData sRTFFieldData;A3D_INITIALIZE_DATA(A3DRTFFieldData, sRTFFieldData );{// .......// TODO: process sRTFFieldData// .......A3DMkpRTFGetField(NULL, &sRTFFieldData) // memory cleanup of the sRTFFieldData structure}A3DMkpRTFDelete(pRTF);}
Enumeration Type Documentation
enum A3DEMarkupSymbol |
Symbol identifiers used in RTF strings.
- Version
- 4.2
Function Documentation
delete RTF data created by A3DMkpRTFInit
- Version
- 4.2
- Deprecated:
- This function is deprecated. Please use the A3DMkpRTFFieldDelete to implement the same behaviour.
- Returns
- A3D_ERROR
-
A3D_SUCCESS
A3DStatus A3DMkpRTFFieldCreate | ( | const A3DUTF8Char * | pRTFString, |
A3DMkpRTFField ** | pRTFField | ||
) |
A3DStatus A3DMkpRTFFieldDelete | ( | const A3DMkpRTFField * | pRTFField | ) |
delete RTF data created by A3DMkpRTFInit Previously A3DMkpRTFDelete.
- Version
- 10.1
- Returns
- A3D_ERROR
-
A3D_SUCCESS
A3DStatus A3DMkpRTFFieldGet | ( | const A3DMkpRTFField * | pRTFField, |
A3DMkpRTFFieldData * | pRTFFieldData | ||
) |
Get each independent field of a RTF data Previously A3DMkpRTFGetField.
- Version
- 10.1
- Returns
- A3D_ERROR
-
A3D_SUCCESS
A3DStatus A3DMkpRTFGetField | ( | A3DVoid * | pRTFData, |
A3DRTFFieldData * | pRTFField | ||
) |
Get each independent field of a RTF data.
- Version
- 4.2
- Deprecated:
- This function is deprecated. Please use the A3DMkpRTFFieldGet to implement the same behaviour.
- Returns
- A3D_ERROR
-
A3D_SUCCESS
A3DStatus A3DMkpRTFInit | ( | const A3DUTF8Char * | pRTF, |
A3DVoid *& | pRTFData | ||
) |
Initialize RTF data for parsing.
- Version
- 4.2
- Deprecated:
- This function is deprecated. Please use the A3DMkpRTFFieldCreate to implement the same behaviour.
- Returns
- A3D_ERROR
-
A3D_SUCCESS