Scroll to navigation

SDL_GetClipboardData(3) SDL3 FUNCTIONS SDL_GetClipboardData(3)

NAME

SDL_GetClipboardData - Get the data from clipboard for a given mime type.

HEADER FILE

Defined in SDL3/SDL_clipboard.h

SYNOPSIS

#include "SDL3/SDL.h"
void * SDL_GetClipboardData(const char *mime_type, size_t *size);

DESCRIPTION

The size of text data does not include the terminator, but the text is guaranteed to be null terminated.

FUNCTION PARAMETERS

the mime type to read from the clipboard.
a pointer filled in with the length of the returned data.

RETURN VALUE

Returns the retrieved data buffer or NULL on failure; call

SDL_GetError () for more information. This should be freed with SDL_free () when it is no longer needed.

THREAD SAFETY

You may only call this function from the main thread.

AVAILABILITY

This function is available since SDL 3.1.3.

SEE ALSO

(3), SDL_HasClipboardData(3), (3), SDL_SetClipboardData(3)

SDL 3.1.6 Simple Directmedia Layer