VCOM:VectorWorks:Workspaces:IWorkspaceToolSet::GetToolAtIndex: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
(New page: __TOC__ <vwDoc> ----------------------------------------------------------------------------------------------------------- <desc> namespace <code>VectorWorks::Workspaces</code> Member o...)
 
m (1 revision)
 
(No difference)

Latest revision as of 15:08, 12 August 2013

.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:IWorkspaceToolSet

Gets the tool at the given index. 

virtual VCOMError VCOM_CALLTYPE GetToolAtIndex(
                        Sint16             inIndex,
                        IWorkspaceTool**   outTool,
                        bool&              outHasSubTools) = 0;

Parameters

inIndex Sint16 the index into the list of buttons to retrieve the tool for.
outTool IWorkspaceTool** on output, if successful, the tool stored at the given index.
outHasSubTools bool& on output, if successful, a bool that indicates whether or not this tool button has sub-tools.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized Bad VCOM instance used to call the fuction.
kVCOMError_Failed Routine failed.
Retrieved from "http://developer.vectorworks.net/index.php?title=VCOM:VectorWorks:Workspaces:IWorkspaceToolSet::GetToolAtIndex&oldid=13591"