---
name: "al_get_clipboard_text"
section: "3alleg5"
platform: "linux"
package: "allegro5-doc"
version: "2:5.2.10.1+dfsg-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/al_get_clipboard_text/3alleg5"
---

# al\_get\_clipboard\_text(3alleg5)

Allegro 5 API

## NAME

al\_get\_clipboard\_text - Allegro 5 API

## SYNOPSIS

-

  ```
  #include <allegro5/allegro.h>
  char *al_get_clipboard_text(ALLEGRO_DISPLAY *display)
  ```

## DESCRIPTION

This function returns a pointer to a string, allocated with al\_malloc(3alleg5) 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(3alleg5) on the returned pointer when you don’t need it anymore.

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.

## SINCE

5\.1.12

## SEE ALSO

al\_set\_clipboard\_text(3alleg5), al\_clipboard\_has\_text(3alleg5)