VCOM:VectorWorks:Workspaces:IWorkspaceFile::GetToolPaletteAtIndex
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:IWorkspaceFile
Gets the tool palette at the given index.
virtual VCOMError VCOM_CALLTYPE GetToolPaletteAtIndex(
Sint16 inIndex,
IWorkspaceToolPalette** outToolPalette) = 0;
Parameters
inIndex Sint16 the index into the list of palettes that we are interested in. outToolPalette IWorkspaceToolPalette** on output, if successful, the tool palette at the given index.
Return Value
Uses standard VCOM Error Reporting.
Return value meaning:
kVCOMError_NotInitialized Bad VCOM instance used to call the fuction. kVCOMError_Failed Routine failed.