SDL_clipboard.h File Reference

#include "SDL_stdinc.h"
#include "begin_code.h"
#include "close_code.h"

Include dependency graph for SDL_clipboard.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	SDL_SetClipboardText (const char *text)
char *	SDL_GetClipboardText (void)
SDL_bool	SDL_HasClipboardText (void)

Detailed Description

Include file for SDL clipboard handling

Definition in file SDL_clipboard.h.

Function Documentation

SDL_GetClipboardText()

char* SDL_GetClipboardText

(

void

)

Get UTF-8 text from the clipboard, which must be freed with SDL_free().

This functions returns empty string if there was not enough memory left for a copy of the clipboard's content.

Returns

the clipboard text on success or an empty string on failure; call SDL_GetError() for more information. Caller must call SDL_free() on the returned pointer when done with it (even if there was an error).

Since

This function is available since SDL 2.0.0.

See also

SDL_HasClipboardText

SDL_SetClipboardText

SDL_HasClipboardText()

SDL_bool SDL_HasClipboardText

(

void

)

Query whether the clipboard exists and contains a non-empty text string.

Returns

SDL_TRUE if the clipboard has text, or SDL_FALSE if it does not.

Since

This function is available since SDL 2.0.0.

See also

SDL_GetClipboardText

SDL_SetClipboardText

SDL_SetClipboardText()

int SDL_SetClipboardText

(

const char *

text

)

Put UTF-8 text into the clipboard.

Parameters

text	the text to store in the clipboard

Returns

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

Since

This function is available since SDL 2.0.0.

See also

SDL_GetClipboardText

SDL_HasClipboardText