IAccPluginInfo Interface Reference

---

Detailed Description

The IAccPluginInfo interface is for information about a plugin.

Public Types

• enum AccPluginType {
    AccPluginType_Unknown = 0,
    AccPluginType_Binary,
    AccPluginType_Widget,
    AccPluginType_UiPlugin
  }
• enum AccPluginInfoProp {
    AccPluginInfoProp_Uuid,
    AccPluginInfoProp_Name,
    AccPluginInfoProp_Version,
    AccPluginInfoProp_Description,
    AccPluginInfoProp_Url,
    AccPluginInfoProp_VendorName,
    AccPluginInfoProp_VendorUrl,
    AccPluginInfoProp_IconUrl,
    AccPluginInfoProp_SmallIconUrl,
    AccPluginInfoProp_Type,
    AccPluginInfoProp_Enabled = 100,
    AccPluginInfoProp_VerificationResult,
    AccPluginInfoProp_TrustFlags,
    AccPluginInfoProp_Started,
    AccPluginInfoProp_Plugin,
    AccPluginInfoProp_LatestVersion,
    AccPluginInfoProp_DownloadUrl,
    AccPluginInfoProp_ContentUrl,
    AccPluginInfoProp_PluginUrl,
    AccPluginInfoProp_SettingsUrl,
    AccPluginInfoProp_AboutUrl,
    AccPluginInfoProp_Commands = 200,
    AccPluginInfoProp_Windows = 300
  }
• typedef enum
  IAccPluginInfo::AccPluginType AccPluginType
• typedef enum
  IAccPluginInfo::AccPluginInfoProp AccPluginInfoProp

Public Member Functions

• HRESULT Uuid ([out, retval] xp_str *uuid)
• HRESULT Property ([in] AccPluginInfoProp property,[out, retval] xp_variant *value)
• HRESULT Property ([in] AccPluginInfoProp property,[in] xp_kvariant value)
• HRESULT GetCommandById ([in] xp_int command,[out, retval] IAccCommand **outCommand)
• HRESULT AddCommand ([in] xp_int command,[out, retval] IAccCommand **outCommand)
• HRESULT RemoveCommand ([in] xp_int command)
• HRESULT GetParameter ([in] xp_kstr name,[out, retval] xp_variant *value)

---

Member Typedef Documentation

typedef enum IAccPluginInfo::AccPluginType IAccPluginInfo::AccPluginType

Values for AccPluginType.

typedef enum IAccPluginInfo::AccPluginInfoProp IAccPluginInfo::AccPluginInfoProp

Properties for the Property method.

---

Member Enumeration Documentation

enum IAccPluginInfo::AccPluginType

Values for AccPluginType.

Enumerator:

AccPluginType_Unknown
AccPluginType_Binary
AccPluginType_Widget
AccPluginType_UiPlugin

enum IAccPluginInfo::AccPluginInfoProp

Properties for the Property method.

Enumerator:

AccPluginInfoProp_Uuid	The UUID of the plugin [get] xp_str*
AccPluginInfoProp_Name	The friendly name of the plugin [get] xp_str*
AccPluginInfoProp_Version	The version of the plugin [get] xp_str*
AccPluginInfoProp_Description	The description of the plugin [get] xp_str*
AccPluginInfoProp_Url	The plugin URL [get] xp_str*
AccPluginInfoProp_VendorName	The vendor name for the plugin [get] xp_str*
AccPluginInfoProp_VendorUrl	The vendor URL for the plugin [get] xp_str*
AccPluginInfoProp_IconUrl	The URL of the icon for the plugin [get] xp_str*
AccPluginInfoProp_SmallIconUrl	The URL of the small icon for the plugin [get] xp_str*
AccPluginInfoProp_Type	The plugin's interface [get] AccPluginType*
AccPluginInfoProp_Enabled	Whether the plugin is enabled [get] xp_bool* [put] xp_bool
AccPluginInfoProp_VerificationResult	Whether the AIM server successfully verified the plugin [get] AccResult*
AccPluginInfoProp_TrustFlags	Additional flags about the plugin returned by the AIM server [get] xp_u32*
AccPluginInfoProp_Started	Whether the plugin has started [get] xp_bool*
AccPluginInfoProp_Plugin	The plugin's interface [get] IAccPlugin**
AccPluginInfoProp_LatestVersion	The latest version of the plugin [get] xp_str*
AccPluginInfoProp_DownloadUrl	The URL for the latest version [get] xp_str*
AccPluginInfoProp_ContentUrl	The URL to the local UIplugin contents [get] xp_str*
AccPluginInfoProp_PluginUrl	The URL for the remote/local UIplugin main page [get] xp_str*
AccPluginInfoProp_SettingsUrl	The URL for the remote/local UIplugin settings [get] xp_str*
AccPluginInfoProp_AboutUrl	The URL for the remote/local UIplugin about page [get] xp_str*
AccPluginInfoProp_Commands	The list of commands supported by the plugin IAccCommands [get] xp_array**
AccPluginInfoProp_Windows	Windows published by the plugin. Used on Win32 so clients can call IsDialogMessage() for the plugin's HWNDs. PVOIDs [get] xp_array** [put] xp_array*

---

Member Function Documentation

HRESULT IAccPluginInfo::Uuid

(

[out, retval] xp_str *

uuid

)

[get]

Gets plugin UUID.

HRESULT IAccPluginInfo::Property	(	[in] AccPluginInfoProp	property,
		[out, retval] xp_variant *	value
	)			[get]

Gets the specified property for a plugin.

HRESULT IAccPluginInfo::Property	(	[in] AccPluginInfoProp	property,
		[in] xp_kvariant	value
	)			[set]

Sets the specified property for a plugin.

HRESULT IAccPluginInfo::GetCommandById	(	[in] xp_int	command,
		[out, retval] IAccCommand **	outCommand
	)

Get a registered plugin command. The entire set of commands can be retrieved via Property(AccPluginInfoProp_Commands);

HRESULT IAccPluginInfo::AddCommand	(	[in] xp_int	command,
		[out, retval] IAccCommand **	outCommand
	)

Register a plugin command. The command can be customized when the call completes.

HRESULT IAccPluginInfo::RemoveCommand

(

[in] xp_int

command

)

Unregister a plugin command.

HRESULT IAccPluginInfo::GetParameter	(	[in] xp_kstr	name,
		[out, retval] xp_variant *	value
	)

Gets a parameter from the plugin.xml file.