Command_GetStringProperty()

Examples


The Command_GetStringProperty() function retrieves a specified string property for a command.

Syntax

Command_GetStringProperty(command_tag, property)

Parameters

command_tag – The integer tag value for the command whose property is being retrieved.

property – An integer constant indicating the property to retrieve. The value corresponds to one of the following constants:

[spacer]

Constant

Description

COMMAND_PROP_ATTACHED_FORM_NAME

The name of the form that is opened by the command.

COMMAND_PROP_CLEAN_DISPLAY_NAME

The text used for the command name, but with special characters excluded.

COMMAND_PROP_DISPLAY_NAME

The text used for the command name, including any special characters.

COMMAND_PROP_TOOLTIP

The tooltip displayed when the command is used on a toolbar.

COMMAND_PROP_SECURITY_FORM_NAME

The name of the security form that is specified for the command.


Return value

A string containing the property value.


Documentation Feedback