get_clipboard_format_name


template <class character>
int get_clipboard_format_name(unsigned format,
                              character* buffer,
                              int size)

This function obtains the name of a registered clipboard format.

Parameters

unsigned format

The identity of the registered format whose name is being queried. Standard format identities in the enumeration clipboard_format may not be requested.

character* buffer

A pointer to a buffer to hold the format name. If the name exceeds the size of the buffer it is truncated.

int size

The size of the buffer (pointed to by the previous parameter) to hold the format name.

Return

int

The number of characters copied to the buffer.