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

SDL_GetClipboardData

Get the data from clipboard for a given mime type.

Header File

Defined in <SDL3/SDL_clipboard.h>

Syntax

const void * SDL_GetClipboardData(const char *mime_type, size_t *size);

Function Parameters

const char * mime_type the mime type to read from the clipboard.
size_t * size a pointer filled in with the length of the returned data.

Return Value

(const void *) Returns the retrieved data buffer or NULL on failure; call SDL_GetError() for more information.

This returns temporary memory which will be automatically freed later, and can be claimed with SDL_ClaimTemporaryMemory().

Remarks

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

Version

This function is available since SDL 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryClipboard


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