node::Warnings::Set

Set a warning message. If a warning with the specified id is already active, false is returned and the new warning is ignored. If id does not yet exist, the warning is set, the UI is updated, and true is returned.

Synopsis

Declared in <node/warnings.h>

[[requires_capability(0x7f2e144313b8)]]
bool
Set(
    warning_type id,
    bilingual_str message);

Return Value

true if the warning was indeed set (i.e. there is no active warning with this id), otherwise false.

Parameters

Name

Description

id [in]

Unique identifier of the warning.

message [in]

Warning message to be shown.

Created with MrDocs