ARPluginSetProperties

Description

The plug-in server calls this optional function immediately after the ARPluginIdentify function to provide information to the plug-in. The information can include plug-in service configuration parameters or services that the plug-in server provides to the plug-ins it loads.

Here, in order to be thread-safe, the plug-in must protect any global information or resources accessed with appropriate mutual exclusion locks.

Related topics

ARPluginCreateInstance

ARPluginDeleteInstance

ARPluginIdentify

ARPluginTermination

ARPluginInitialization

Synopsis

#include "area.h"

int ARPlugInSetProperties(
  ARPropList *propList,
  ARStatusList status)

Input arguments

propList

List of ARPropStruct structures. The following property is supported:

Return values

status

List of zero or more notes, warnings, or errors generated from a call made to this function.

For a description of all possible values, see Error-checking.

Important

To prevent multiple plug-ins from using the same error code, include some identification in the associated text loaded into the status array of the externally written plug-in.

For example: Prefix the error message with "Employee Plug-in:" or "My Plug-in:".

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*