Skip to main content

SDL_WriteIO

Function SDL_WriteIO 

Source
pub unsafe extern "C" fn SDL_WriteIO(
    context: *mut SDL_IOStream,
    ptr: *const c_void,
    size: usize,
) -> usize
Expand description

Write to an SDL_IOStream data stream.

This function writes exactly size bytes from the area pointed at by ptr to the stream. If this fails for any reason, it’ll return less than size to demonstrate how far the write progressed. On success, it returns size.

On error, this function still attempts to write as much as possible, so it might return a positive value less than the requested write size.

The caller can use SDL_GetIOStatus() to determine if the problem is recoverable, such as a non-blocking write that can simply be retried later, or a fatal error.

A request for zero bytes on a valid stream will return zero immediately without accessing the stream, so the stream status (EOF, err, etc) will not change.

Parameter: context a pointer to an SDL_IOStream structure. Parameter: ptr a pointer to a buffer containing data to write. Parameter: size the number of bytes to write. Returns: the number of bytes written, which will be less than size on failure; call SDL_GetError() for more information.

Thread Safety: Do not use the same SDL_IOStream from two threads at once.

Available Since: This function is available since SDL 3.2.0.

See Also: SDL_IOprintf See Also: SDL_ReadIO See Also: SDL_SeekIO See Also: SDL_FlushIO See Also: SDL_GetIOStatus