PA_GetAdvancedPropertiesToDispose

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

version 2003


PA_GetAdvancedPropertiesToDispose (params) void*

ParameterTypeDescription
paramsPA_PluginParametersParameters received in PluginMain
Function resultvoid*Pointer to the advanced properties

Description

The routine PA_GetAdvancedPropertiesToDispose returns the advanced properties pointer given to 4th Dimension by a previous call to PA_SetAdvancedProperties. This gives the area the possibility of disposing of this data if it is no longer needed.

params is the PA_PluginParameters the plug-in received in its PluginMain routine.

This routine must be called when PA_GetAreaEvent returns eAE_DisposeAdvancedProperties. Otherwise, it returns 0 and PA_GetLastError returns eER_BadEventCall.

Example

See the complete example in Create and use an external area.

See Also

Create and use an external area, PA_GetAdvancedProperties, PA_SetAdvancedProperties, PA_SetAdvancedPropertiesEditable.

Error Handling

Use PA_GetLastError to see if an error occurred (eER_BadEventCall).


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