Share

_ARXCOMMAND_ENTRY

C++

struct _ARXCOMMAND_ENTRY {
  const ACHAR * pszCmdGroupName;
  const ACHAR * pszCmdGlobalName;
  const ACHAR * pszCmdLocalName;
  Adesk::Int32 commandFlags;
  AcRxFunctionPtr pCmdFct;
  AcEdUIContext * pUIContext;
  UINT localNameID;
};

File

arxEntryPoint.h

Members

Members Description
pszCmdGroupName Input pointer to null-terminated string that is the name of the command group name to which you add the command.
pszCmdGlobalName Input pointer to null-terminated string that is the international and untranslated name of the command to add.
pszCmdLocalName Input pointer to null-terminated string that is the local and translated name of the command to add. Can be NULL if localNameID parameter is used.
commandFlags Input flags associated with the command. The flags should be either ACRX_CMD_TRANSPARENT, or ACRX_CMD_MODAL, and can be logically ORd with secondary flags such as ACRX_CMD_USEPICKSET or ACRX_CMD_REDRAW (see AcEdCommandStack::addCommand for more details).
pCmdFct Input pointer to the function to be executed when this command is invoked.
pUIContext Input resource ID of the string to use for the translated command name (limited to 132 characters).
localNameID Input resource ID of the string to use for the translated command name (limited to 132 characters). pszCmdLocalName needs to be NULL if used.

Description

This structure encapsulates names, command flags, contexts , and other information required by ARX defined commands created using the ACED_ARXCOMMAND_ENTRY_AUTO, and ACED_ARXCOMMAND_ENTRYBYID_AUTO macros (see AcEdCommandStack::addCommand() for more details).

Was this information helpful?