VCOM:VectorWorks:UI:IInfoBar::SetMinorAlert

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

Member of VCOM:VectorWorks:UI:IInfoBar

Set text into the Info bar.

virtual VCOMError VCOM_CALLTYPE SetMinorAlert(
const TXString& strAlert,
EInfoMsgBackColor backClr) = 0;

Parameters

strAlert const TXString& The alert text;
backClr EInfoMsgBackColor Background color. See VCOM:VectorWorks:UI:IInfoBar#Remarks

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

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