VCOM:VectorWorks:Workspaces:IWorkspaceMenuBar::GetMenuAtIndex

From Vectorworks Developer
Jump to navigation Jump to search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::Workspaces

Member of VCOM:VectorWorks:Workspaces:IWorkspaceMenuBar

Gets menu at the given index.

virtual VCOMError VCOM_CALLTYPE GetMenuAtIndex(
Sint16 inIndex,
IWorkspaceMenu** outMenu) = 0;

Parameters

inIndex Sint16 the index of the menu to retrieve.
outMenu IWorkspaceMenu** on output, if successful, a pointer to a menu pointer.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized Bad VCOM instance used to call the fuction.
kVCOMError_Failed Routine failed.