Developer

API Reference

IRichTextModel_GetMarkupText()

Brew Release
Brew MP 1.0.2
See Also
- IRichTextModel Interface
- Tag
- IRichTextModel_SetMarkupText()
Description
This function gets serialized markup text from the text and tags of the TextModel.
Parameters
  • pif
    []:
    Pointer to the IRichTextModel interface object.
  • pwMText
    []:
    This is a pointer to the markup text buffer. On output, the buffer is filled with null terminated markup text. If the buffer is too small, as much null terminated markup text as possible is copied. If the buffer pointer is null, nothing is copied.
  • pnSize
    []:
    On input, pnSize is a pointer to the size in bytes of the markup text buffer. On output, pnSize is a pointer to the size in bytes of the markup text. If pnSize is null, the function returns AEE_EBADPARM. To guarantee that a buffer is large enough to hold all of the markup text, call this function twice. The first time pass in null for the markup text buffer and zero for the size. No markup text is copied, but the required markup text buffer size is returned. Allocate the buffer and call the function again passing in the buffer and size.
Prototype
   int IRichTextModel_GetMarkupText(IRichTextModel* pif, AECHAR* pwMText, int* pnSize)
Return
   AEE_SUCCESS  - The operation succeeded.
   AEE_EBADPARM - The operation failed due to an invalid parameter.
   AEE_EFAILED  - The operation failed due to an unknown error.
Side Effect
None
Comment
See Tag for format of opening and closing tag used in markup text.
  • Follow