version 2003
PA_ReturnPicture (params; pnewPicture; pictSize; info)
Parameter | Type | Description | |
params | PA_PluginParameters | Parameters received in PluginMain | |
pnewPicture | void* | Pointer to the new picture data to be returned | |
pictSize | long | Picture size in bytes | |
info | PA_PictureInfo | Picture info (Background) |
Description
The routine PA_ReturnPicture sets the returned value of the plug-in routine to the picture data pointed to by the handle newPicture. Pass the background-drawing 4D information in info.
After the call, picture still belongs to the plug-in, you can dispose of it.
Be sure that, with this call, the picture is duplicated to the result value. You can dispose of it once you have finished working with it. If you simply want to return the handle itself without duplicating the picture data, use PA_ReturnPBlobHandle.
See Create a new plug-in for a description of returned values accessors.
See Also
Create a new plugin, PA_ReturnPictureHandle.
Error Handling
None.