push_clipboard_index

January 19th 2020

Get a copy of a string from the clipboard history by index

Signature

C++

String_Const_u8
push_clipboard_index(Application_Links* app,
                     Arena* arena,
                     i32 clipboard_id,
                     i32 item_index);

Parameters

app

the standard custom layer context pointer

arena

the arena on which the returned string will be allocated

clipboard_id

the id of the clipboard to query - currently an ignored parameter and should be set to zero

item_index

the index in the clipboard history to query, 0 always the most recent string in the history

Return

on success, when the clipboard contains a string at the given index, a copy of the string is returned, otherwise an empty string is returned