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

RTF_Load_IO

Set the text of an RTF context, with data loaded from an SDL_IOStream.

Header File

Defined in <SDL3_rtf/SDL_rtf.h>

Syntax

bool RTF_Load_IO(RTF_Context *ctx, SDL_IOStream *src, bool closeio);

Function Parameters

RTF_Context *	ctx	the RTF context to update.
SDL_IOStream *	src	the SDL_IOStream to load RTF data from.
bool	closeio	true to close src when the font is closed, false to leave it open.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

This can be called multiple times to change the text displayed.

If closeio is true, this function will close src, whether this function succeeded or not.

On failure, call RTF_GetError() to get a human-readable text message corresponding to the error.

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.