.\" Automatically generated by Pandoc 3.1.6.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "al_get_clipboard_text" "3" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_get_clipboard_text - Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <allegro5/allegro.h>

char *al_get_clipboard_text(ALLEGRO_DISPLAY *display)
\f[R]
.fi
.SH DESCRIPTION
.PP
This function returns a pointer to a string, allocated with al_malloc(3)
with the text contents of the clipboard if available.
If no text is available on the clipboard then this function returns
NULL.
You must call al_free(3) on the returned pointer when you don\[cq]t need
it anymore.
.PP
Beware that text on the clipboard on Windows may be in Windows format,
that is, it may have carriage return newline combinations for the line
endings instead of regular newlines for the line endings on Linux or
OSX.
.SH SINCE
.PP
5.1.12
.SH SEE ALSO
.PP
al_set_clipboard_text(3), al_clipboard_has_text(3)