ScBar_AddMacro()

Examples


The ScBar_AddMacro() function adds a shortcut for a macro to the Shortcut Bar.

Syntax

ScBar_AddMacro(type, name, parent_ID, shortcut_display_name, macro_name)

Parameters

type – An integer indicating whether the shortcut is being added for a specific user or for a specific user class. Use one of the following constants (which are part of the syScBarObj form):

[spacer]

Constant

Description

scgPERSONAL

The shortcut is being added for a specific user.

scgUSERCLASS

The shortcut is being added for a specific user class.


name – A string specifying the user name or user class to which the shortcut is being added.

parent_ID – An integer indicating the parent node to which the shortcut will be added. The value 0 indicates the root level.

shortcut_display_name – A string containing the text that will be used for the shortcut.

macro_name – A string specifying the path to the macro file. The path must be in native format.

Return value

A boolean. True indicates the shortcut was successfully added, while false indicates it was not.


Documentation Feedback