(This function is part of SDL_rtf, a separate library from SDL.)

RTF_GetTitle

Get the title of an RTF document.

Header File

Defined in <SDL3_rtf/SDL_rtf.h>

Syntax

const char * RTF_GetTitle(RTF_Context *ctx);

Function Parameters

RTF_Context *

ctx

the RTF context to query.

Return Value

(const char *) Returns the document title in UTF-8 encoding.

Remarks

The returned string is part of the RTF_Context, and should not be modified or freed by the application. The pointer remains valid until the RTF_Context is freed.

Version

This function is available since SDL_rtf 3.0.0.

---

CategoryAPI, CategoryAPIFunction

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.