Main Page | Class Hierarchy | Class Members | Global Enums and Constants | Global Entry Points | Related Pages

IAccCommand Interface Reference


Detailed Description

The IAccCommand interface is for enumerating commands on a plugin.

Public Types

Public Member Functions

Properties


Member Typedef Documentation

typedef enum IAccCommand::AccCommandFlags IAccCommand::AccCommandFlags

Values for AccCommandProp_Flags.

typedef enum IAccCommand::AccCommandProp IAccCommand::AccCommandProp

Properties for the Property method.


Member Enumeration Documentation

enum IAccCommand::AccCommandFlags

Values for AccCommandProp_Flags.

Enumerator:
AccCommandFlags_BuddyCentric 
AccCommandFlags_ActionsUi 
AccCommandFlags_BuddyUi 
AccCommandFlags_GroupUi 
AccCommandFlags_ImSessionUi 
AccCommandFlags_PreferencesUi 
AccCommandFlags_AboutUi 

enum IAccCommand::AccCommandProp

Properties for the Property method.

Enumerator:
AccCommandProp_Id  The id for the command [get] xp_int*
AccCommandProp_Text  The text for the command [get] xp_str* [put] xp_kstr
AccCommandProp_SmallIconUrl  The URL for an icon to display with the command [get] xp_str* [put] xp_kstr
AccCommandProp_Flags  The flags for the Command, from AccCommandFlags [get] xp_u32* [put] xp_u32
AccCommandProp_ParentId  The parent id for the command. If not -1, this command is associated in UI with its parent command (e.g., in a submenu). [get] xp_int* [put] xp_int


Member Function Documentation

HRESULT IAccCommand::QueryStatus ( [in] xp_kvariant  usernames,
[out, retval] xp_vbool enabled 
)

Indicates whether this command could be executed on certain user(s). If an error is returned, or "enabled" is false, the command would not be allowed, so it should be disabled in the user interface.

HRESULT IAccCommand::Exec ( [in] xp_kvariant  usernames  ) 

Executes the command on the specified users.


Property Documentation

xp_int IAccCommand::Id [get]

Gets command id.

xp_variant IAccCommand::Property( [in] AccCommandProp property) ( [in] AccCommandProp  property  )  [get]

Gets the specified property for a command.

xp_kvariant IAccCommand::Property( [in] AccCommandProp property) ( [in] AccCommandProp  property  )  [set]

Sets the specified property for a command.


Questions? Stop by the AIM SDK Developer Forum
Created Mon Oct 15 18:06:39 2007 for AIM: Developer SDK
© 2007 AOL LLC. All Rights Reserved.