(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_RWclose

Close and free an allocated SDL_RWops structure.

Syntax

int SDL_RWclose(SDL_RWops *context);

Function Parameters

context

SDL_RWops structure to close

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

SDL_RWclose() closes and cleans up the SDL_RWops stream. It releases any resources used by the stream and frees the SDL_RWops itself with SDL_DestroyRW(). This returns 0 on success, or -1 if the stream failed to flush to its output (e.g. to disk).

Note that if this fails to flush the stream to disk, this function reports an error, but the SDL_RWops is still invalid once this function returns.

Version

This function is available since SDL 3.0.0.

Code Examples

Uint8 buf[256];
SDL_RWops *rw = SDL_RWFromFile("test.bin", "r");
if (rw != NULL) {
    SDL_RWread(rw, buf, sizeof (buf), 1);
    SDL_RWclose(rw);
}
// Go on and use the data in buf...

Related Functions

• SDL_RWFromConstMem
• SDL_RWFromFile
• SDL_RWFromMem
• SDL_RWread
• SDL_RWseek
• SDL_RWwrite

---

CategoryAPI, CategoryIO

---

[ edit | delete | history | feedback | raw ]

[ 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.