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.

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 the 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 made to this function.

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