PA_SetBlobHandleParameter

4D - Documentation   Français   English   German   4D Plugin API, Command Theme List   4D Plugin API, Command Alphabetical List   Back   Previous   Next

version 2003


PA_SetBlobHandleParameter (params; index; hblob)

ParameterTypeDescription
paramsPA_PluginParametersParameters received in PluginMain
indexshortIndex of the parameter in params
hblobPA_HandleNew BLOB handle

Description

The routine PA_SetBlobHandleParameter sets the value of the BLOB handle in the index parameter in params to hblob.

Pass a handle to the new data in hblob. This can be useful if you no longer need to use the handle as it will not be duplicated, as PA_SertBlobParameter does (which can lead to memory problems for "larger" BLOBs).

The previous BLOB in the parameter is disposed.

WARNING

After the call, the handle belongs to 4D; you must never dispose of it.

See Create a new plug-in for a description of parameter accessors.

NOTE:

The first parameter starts at index 1

Example

Set a BLOB parameter.

   PA_Handle   h;
   h = PA_NewHandle(kMY_BUFFER_SIZE);
   /* . . . fill the handle . . .*/
   PA_SetBlobHandleParameter(params, index, h);
   // Never call DisposeHandle(h) from now.

See Also

Create a new plugin, PA_SetBlobParameter.

Error Handling

None.


4D - Documentation   Français   English   German   4D Plugin API, Command Theme List   4D Plugin API, Command Alphabetical List   Back   Previous   Next