VCOM:VectorWorks:Workspaces:IWorkspaceFile::DeleteToolPalette

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:IWorkspaceFile

Deletes the given tool palette from the workspace and sets the IWorkspaceToolPalette NULL.

virtual VCOMError VCOM_CALLTYPE DeleteToolPalette(
IWorkspaceToolPalette** ioToolPalette) = 0;

Parameters

ioToolPalette IWorkspaceToolPalette** on output, if successful, a pointer to a NULL 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.