Notes - LayoutTransformText

The LayoutTransform function transforms the InpBuf text according to the current layout values in layout object. Any layout value whose value type is LayoutTextDisriptor describes the attributes of the InpBuf and OutBuf. If the attributes are the same of both InpBuf and OutBuf then a null transformation is done with respect to that specific layout avalue.

The output of this functions may be one or more of the following depending on the setting of the respective arguments:

OutBuf/Outsize

any transform data is stored into OutBuf.
InpToOut
a cross reference from each InpBuf code element to the transformed data.
OutToInp
a cross reference to each InpBuf code element from the transformed data.
BidiLevel
a weighted value that represents the directional level of each InpBuf code element. The level is dependent on the internal directional algorithm of the layout object.

Each of these output arguments maybe NULL to specify that no output is desired for the specific argument, but at least one of them should be set to non-NULL to perform any significant work.

When the size of OutBuf is not large enough to contain the entire transformed text, the input text state at the end of the error condition LAYOUT_E2BIG is returned. To resume the transformation on the remaining text, the application should call the LayoutTransform function with the same layout object, the same InpBuf, and Inpsize is set to zero (0).

---

[Back: Errors - LayoutTransformText]
[Next: Example - LayoutTransformText]