PA_SetAdvancedProperties

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

version 2003


PA_SetAdvancedProperties (params; data; dataSize)

ParameterTypeDescription
paramsPA_PluginParametersParameters received in PluginMain
datavoid*Pointer to advanced properties data
dataSizelongData size in bytes

Description

The routine PA_SetAdvancedProperties tells 4th Dimension to "link" the advanced properties to that particular area. This way, the advanced properties can be retrieved from eAE_AreaInit at Runtime.

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

data is a pointer to the memory block that holds the advanced properties.

dataSize is the data size in bytes.

This routine must be called when PA_GetAreaEvent returns eAE_EditAdvancedProperties. Otherwise, it does nothing and PA_GetLastError returns eER_BadEventCall.

Area event eAE_EditAdvancedProperties will be followed by the eAE_DisposeAdvancedProperties to tell the area to release the data buffer given to 4D.

Example

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

See Also

Create and use an external area, PA_GetAdvancedProperties, PA_GetAdvancedPropertiesToDispose, 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