Developer

API Reference

IClipboard_GetData()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IClipboard IClipboard_SetData
Description
This function copies clipboard data for the specified clipboard format to the destination buffer. The size copied is returned in the size parameter.
Note: - Passing a destination of NULL fills the size with the destination size.
- Passing a destination size that is too small returns an error.
Parameters
  • po
    []:
    Clipboard interface object.
  • pszName
    []:
    Name of the format.
  • pvDest
    []:
    Pointer to destination data buffer.
  • pnDestSize
    []:
    Input size of destination buffer and output size copied.
Interface
Prototype
   int IClipboard_GetData(IClipboard *po, const char *cpszName,
                          void *pvDest, int *pnDestSize);
Return
AEE_SUCCESS : Success. AEE_EFAILED : The format is not supported. AEE_EBADPARM : Invalid parameter. AEE_ENOMEMORY : Insufficient buffer size passed to function.
Side Effect
None.
Comment
None
  • Follow