JVCL Help:TJvClipboard.GetBuffer

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Gets a buffer of the given format


Pascal

 functionGetBuffer(Format: Word; Buffer: Pointer; Size: Cardinal): Boolean;


Parameters

Parameters Description
Format: Word The format ID
Buffer: Pointer An allocated buffer
Size: Cardinal The size of the allocated buffer and of the data to retrieve


Return Value

True if data was successfully retrieved, else use Windows.GetLastError to get the error code


Description

The format must be present in the clipboard. If not the function returns false. The buffer and the size parameters must be set to the correct size for the specified format. If they are too small, the data will be truncated, resulting in corrupted values on your side (but you're the one who knows what to do with that). If they are too large, the application will crash as it will be asking the system for more data than available


See Also

TJvClipboard.OnRenderFormat


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page