RTF parsing

Types

	A3DMkpRTFFieldData
	`A3DEMarkupSymbol`

Fields

	`KEA3DSymbol_UNKNOWN`
	`KEA3DSymbol_Angularity`
	`KEA3DSymbol_MoreOrLess`
	`KEA3DSymbol_Micron`
	`KEA3DSymbol_Circularity`
	`KEA3DSymbol_Concentricity`
	`KEA3DSymbol_Cylindricity`
	`KEA3DSymbol_Parallelism`
	`KEA3DSymbol_Perpendicularity`
	`KEA3DSymbol_Symmetry`
	`KEA3DSymbol_TotalRunout`
	`KEA3DSymbol_Straightness`
	`KEA3DSymbol_Flatness`
	`KEA3DSymbol_LineProfile`
	`KEA3DSymbol_SurfaceProfile`
	`KEA3DSymbol_Runout`
	`KEA3DSymbol_Countersink`
	`KEA3DSymbol_Counterbore`
	`KEA3DSymbol_Depth`
	`KEA3DSymbol_Centerline`
	`KEA3DSymbol_Ohm`
	`KEA3DSymbol_Omega`
	`KEA3DSymbol_SmallerOrEqual`
	`KEA3DSymbol_GreaterOrEqual`
	`KEA3DSymbol_Slope`
	`KEA3DSymbol_ConicalTaper`
	`KEA3DSymbol_Diameter`
	`KEA3DSymbol_FreeState`
	`KEA3DSymbol_LeastMaterial`
	`KEA3DSymbol_MaximumMaterial`
	`KEA3DSymbol_ProjectedTolerance`
	`KEA3DSymbol_TangentPlane`
	`KEA3DSymbol_Statistical`
	`KEA3DSymbol_Position`
	`KEA3DSymbol_Square`
	`KEA3DSymbol_Triangle`
	`KEA3DSymbol_between`
	`KEA3DSymbol_RegardlessOfFeatureSize`
	`KEA3DSymbol_Degre`
	`KEA3DSymbol_Encompassing`
	`KEA3DSymbol_CircledU`
	`KEA3DSymbol_CircledR`
	`KEA3DSymbol_RightwardArrow`
	`KEA3DSymbol_SubsetOf`
	`KEA3DSymbol_1STANG`
	`KEA3DSymbol_3RDANG`
	`KEA3DSymbol_BREAK15`
	`KEA3DSymbol_BREAK30`
	`KEA3DSymbol_DATUM1`
	`KEA3DSymbol_DATUM2`
	`KEA3DSymbol_MINUS`
	`KEA3DSymbol_PLINE`
	`KEA3DSymbol_PLUS`
	`KEA3DSymbol_STRETCH`
	`KEA3DSymbol_STS`
	`KEA3DSymbol_STS_`
	`KEA3DSymbol_STS_ANG`
	`KEA3DSymbol_STS_ANG_`
	`KEA3DSymbol_STS_BAS`
	`KEA3DSymbol_STS_BAS_`
	`KEA3DSymbol_STS_CIR`
	`KEA3DSymbol_STS_CIR_`
	`KEA3DSymbol_STS_MAT`
	`KEA3DSymbol_STS_MAT_`
	`KEA3DSymbol_STS_MLT`
	`KEA3DSymbol_STS_MLT_`
	`KEA3DSymbol_STS_NOM`
	`KEA3DSymbol_STS_NOM_`
	`KEA3DSymbol_STS_PAR`
	`KEA3DSymbol_STS_PAR_`
	`KEA3DSymbol_STS_PER`
	`KEA3DSymbol_STS_PER_`
	`KEA3DSymbol_STS_PRT`
	`KEA3DSymbol_STS_PRT_`
	`KEA3DSymbol_STS_RAD`
	`KEA3DSymbol_STS_RAD_`

Functions

`A3DStatus`	`A3DMkpRTFFieldCreate`
`A3DStatus`	`A3DMkpRTFInit`
`A3DStatus`	`A3DMkpRTFFieldGet`
`A3DStatus`	`A3DMkpRTFGetField`
`A3DStatus`	`A3DMkpRTFFieldDelete`
`A3DStatus`	`A3DMkpRTFDelete`

Detailed Description

group a3d_markup_rtf

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;
if(A3DMkpRTFInit(pRTF_UTF8, pRTF) == A3D_SUCCESS)
{
    A3DRTFFieldData sRTFFieldData;
    A3D_INITIALIZE_DATA(A3DRTFFieldData, sRTFFieldData );

    while(A3DMkpRTFGetField(pRTF, &sRTFFieldData) == A3D_SUCCESS)
    {
        // .......
        // TODO: process sRTFFieldData
        // .......

        A3DMkpRTFGetField(NULL, &sRTFFieldData)     // memory cleanup of the sRTFFieldData structure
    }

    A3DMkpRTFDelete(pRTF);
}

Type Documentation

enum A3DEMarkupSymbol

Symbol identifiers used in RTF strings.

Version: 4.2

Values:

enumerator KEA3DSymbol_UNKNOWN: Not a symbol.

enumerator KEA3DSymbol_Angularity: Angularity.

enumerator KEA3DSymbol_MoreOrLess: MoreOrLess.

enumerator KEA3DSymbol_Micron: Micron.

enumerator KEA3DSymbol_Circularity: Circularity.

enumerator KEA3DSymbol_Concentricity: Concentricity.

enumerator KEA3DSymbol_Cylindricity: Cylindricity.

enumerator KEA3DSymbol_Parallelism: Parallelism.

enumerator KEA3DSymbol_Perpendicularity: Perpendicularity.

enumerator KEA3DSymbol_Symmetry: Symmetry.

enumerator KEA3DSymbol_TotalRunout: TotalRunout.

enumerator KEA3DSymbol_Straightness: Straightness.

enumerator KEA3DSymbol_Flatness: Flatness.

enumerator KEA3DSymbol_LineProfile: LineProfile.

enumerator KEA3DSymbol_SurfaceProfile: SurfaceProfile.

enumerator KEA3DSymbol_Runout: Runout.

enumerator KEA3DSymbol_Countersink: Countersink.

enumerator KEA3DSymbol_Counterbore: Counterbore.

enumerator KEA3DSymbol_Depth: Depth.

enumerator KEA3DSymbol_Centerline: Centerline.

enumerator KEA3DSymbol_Ohm: Ohm.

enumerator KEA3DSymbol_Omega: Omega.

enumerator KEA3DSymbol_SmallerOrEqual: SmallerOrEqual.

enumerator KEA3DSymbol_GreaterOrEqual: GreaterOrEqual.

enumerator KEA3DSymbol_Slope: Slope.

enumerator KEA3DSymbol_ConicalTaper: ConicalTaper.

enumerator KEA3DSymbol_Diameter: Diameter.

enumerator KEA3DSymbol_FreeState: FreeState.

enumerator KEA3DSymbol_LeastMaterial: LeastMaterial.

enumerator KEA3DSymbol_MaximumMaterial: MaximumMaterial.

enumerator KEA3DSymbol_ProjectedTolerance: ProjectedTolerance.

enumerator KEA3DSymbol_TangentPlane: TangentPlane.

enumerator KEA3DSymbol_Statistical: Statistical.

enumerator KEA3DSymbol_Position: Position.

enumerator KEA3DSymbol_Square: Square.

enumerator KEA3DSymbol_Triangle: Triangle.

enumerator KEA3DSymbol_between: between.

enumerator KEA3DSymbol_RegardlessOfFeatureSize: RegardlessOfFeatureSize.

enumerator KEA3DSymbol_Degre: Degre.

enumerator KEA3DSymbol_Encompassing: Encompassing.

enumerator KEA3DSymbol_CircledU: CircledU.

enumerator KEA3DSymbol_CircledR: CircledR.

enumerator KEA3DSymbol_RightwardArrow: RightwardArrow.

enumerator KEA3DSymbol_SubsetOf: SubsetOf.

enumerator KEA3DSymbol_1STANG: 1STANG.

enumerator KEA3DSymbol_3RDANG: 3RDANG.

enumerator KEA3DSymbol_BREAK15: BREAK15.

enumerator KEA3DSymbol_BREAK30: BREAK30.

enumerator KEA3DSymbol_DATUM1: DATUM1.

enumerator KEA3DSymbol_DATUM2: DATUM2.

enumerator KEA3DSymbol_MINUS: MINUS.

enumerator KEA3DSymbol_PLINE: PLINE.

enumerator KEA3DSymbol_PLUS: PLUS.

enumerator KEA3DSymbol_STRETCH: STRETCH.

enumerator KEA3DSymbol_STS: STS.

enumerator KEA3DSymbol_STS_: STS_.

enumerator KEA3DSymbol_STS_ANG: STS_ANG.

enumerator KEA3DSymbol_STS_ANG_: STS_ANG_.

enumerator KEA3DSymbol_STS_BAS: STS_BAS.

enumerator KEA3DSymbol_STS_BAS_: STS_BAS_.

enumerator KEA3DSymbol_STS_CIR: STS_CIR.

enumerator KEA3DSymbol_STS_CIR_: STS_CIR_.

enumerator KEA3DSymbol_STS_MAT: STS_MAT.

enumerator KEA3DSymbol_STS_MAT_: STS_MAT_.

enumerator KEA3DSymbol_STS_MLT: STS_MLT.

enumerator KEA3DSymbol_STS_MLT_: STS_MLT_.

enumerator KEA3DSymbol_STS_NOM: STS_NOM.

enumerator KEA3DSymbol_STS_NOM_: STS_NOM_.

enumerator KEA3DSymbol_STS_PAR: STS_PAR.

enumerator KEA3DSymbol_STS_PAR_: STS_PAR_.

enumerator KEA3DSymbol_STS_PER: STS_PER.

enumerator KEA3DSymbol_STS_PER_: STS_PER_.

enumerator KEA3DSymbol_STS_PRT: STS_PRT.

enumerator KEA3DSymbol_STS_PRT_: STS_PRT_.

enumerator KEA3DSymbol_STS_RAD: STS_RAD.

enumerator KEA3DSymbol_STS_RAD_: STS_RAD_.

Function Documentation

A3DStatus A3DMkpRTFFieldCreate(const A3DUTF8Char *pRTFString, A3DMkpRTFField **pRTFField)

Initialize RTF data for parsing Previously A3DMkpRTFInit.

Version: 10.1

Return values

A3D_ERROR –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMkpRTFInit(const A3DUTF8Char *pRTF, A3DVoid **pRTFData)

Initialize RTF data for parsing.

Deprecated:: This function is deprecated. Please use the A3DMkpRTFFieldCreate to implement the same behaviour.

Version: 4.2

Return values

A3D_ERROR –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMkpRTFFieldGet(const A3DMkpRTFField *pRTFField, A3DMkpRTFFieldData *pRTFFieldData)

Get each independent field of a RTF data Previously A3DMkpRTFGetField.

Version: 10.1

Return values

A3D_ERROR –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMkpRTFGetField(A3DVoid *pRTFData, A3DRTFFieldData *pRTFField)

Get each independent field of a RTF data.

Deprecated:: This function is deprecated. Please use the A3DMkpRTFFieldGet to implement the same behaviour.

Version: 4.2

Return values

A3D_ERROR –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMkpRTFFieldDelete(const A3DMkpRTFField *pRTFField)

delete RTF data created by A3DMkpRTFInit Previously A3DMkpRTFDelete.

Version: 10.1

Return values

A3D_ERROR –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMkpRTFDelete(A3DVoid *pRTFData)

delete RTF data created by A3DMkpRTFInit

Deprecated:: This function is deprecated. Please use the A3DMkpRTFFieldDelete to implement the same behaviour.

Version: 4.2

Return values

A3D_ERROR –
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code