Skip to Content
Information
This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

ARPluginSetProperties

Description

The plug-in server calls this optional function immediately after ARPluginIdentify 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.

To be thread-safe, your plug-in must protect any global information or resources accessed here with appropriate mutual exclusion locks.

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 to this function. For a description of all possible values, see Error-checking.

Warning

Note

To avoid confusion if multiple plug-ins choose 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:".

See also

ARPluginCreateInstance, ARPluginDeleteInstance, ARPluginIdentify, ARPluginTermination, ARPluginInitialization

 

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

AR System 21.3