CX_CommandInfo struct

Structure used to specify supported commands to the host application.

Syntax

struct CX_CommandInfo
{
   CX_CommandInfo() { ZeroMemory(this, sizeof(*this)); };

   DWORD dwFlags;
   DWORD dwValidFlags;
   DWORD dwFormatID[16];
   wchar_t szName[40];
   wchar_t szMenuItemName[40];
   wchar_t szDescription[80];
   UINT iIcon;
   wchar_t szBtnLabel[36];
   DWORD dwCategories;
};

Members

dwFlags

Type: DWORD

CX_CI Flags

dwValidFlags

Type: DWORD

CX_CVF Validity flags

dwFormatID

Type: DWORD [16]

Specifies acceptable image formats (valid if CVF_FORMATIDLIST flag is set in dwValidFlags). Use the MAKE_FORMATID macro to generate format identifiers.

szName

Type: wchar_t [40]

Name of this command (used for toolbar button help hint)

szMenuItemName

Type: wchar_t [40]

Menu item label for this command

szDescription

Type: wchar_t [80]

Description of command (used for status bar help hint)

iIcon

Type: UINT

Command icon index (ordinal icon index in APL module resources)

szBtnLabel

Type: wchar_t [36]

Button label (valid if CX_CI_BTNLABEL flag is set in dwFlags)

dwCategories

Type: DWORD

Command categories bitmask (valid if CX_CI_CATEGORIES flag is set in dwFlags); can be a combination of the CX_CN flags

Remarks

This structure is used by the CX_PlugInInfo structure.

Requirements

Header: CX_PlugIn.h

See also: