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.

ARPluginIdentify


Description

This function provides the type, name, and version of a plug-in. The plug-in server uses this information to identify the plug-in. The server calls this function when it loads a plug-in.

Warning

Important

If you do not define this function, the plug-in server does not load the plug-in.

Synopsis


#include "arplugin.h"

int ARPluginIdentify(
  ARPluginIdentification *id,
  ARStatusList *status)

Return arguments

id

Plug-in type, name, and version.

type

Type of plug-in in this form: AR_PLUGIN_TYPE_Type

name

Unique name of the plug-in.

version

Plug-in version, which is appended to the plug-in type: AR_PLUGIN_Type_VERSION

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.

See also

ARPluginCreateInstance, ARPluginDeleteInstance, ARPluginInitialization, ARPluginTermination.

 

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

AR System 21.3