StatusMessages.addWarning Method

StatusMessages

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Syntax

Python
C++

"statusMessages_var" is a variable referencing a StatusMessages object.

# Uses no optional arguments.
returnValue = statusMessages_var.addWarning()

# Uses optional arguments.
returnValue = statusMessages_var.addWarning(messageId, message)

"statusMessages_var" is a variable referencing a StatusMessages object.

#include <Core/Application/StatusMessages.h>

// Uses no optional arguments.
returnValue = statusMessages_var->addWarning();

// Uses optional arguments.
returnValue = statusMessages_var->addWarning(messageId, message);

Parameters

messageId

string

The ID of a predefined message or if an empty string is provided, the default error message will be used. The displayed message is localized based on the current default language in Fusion. Below is a list of some valid message ID's and the corresponding English message.

"API_COMPUTE_ERROR" - "Cannot compute this feature."
"API_COMPUTE_WARNING" - "This feature computed with warnings."
"CFLANGE_INVALID_GEOM" - "Invalid input sketch curve."
"DRAFT_MISSING_FACE_REFERENCES" - "Missing face references"
"DRAFT_MISSING_REFERENCE_PLANE" - "Missing reference plane"
"FEATURE_ENTITY_TYPE_INVALID" - "Entity type is invalid"
"FEATURE_FAILED_TO_CREATE" - "Failed to create feature"
"FEATURE_MISSING_INPUTS" - "Missing inputs"
"FEATURE_REFERENCE_LOST" - "Reference is lost"
"Feature_Compute_Error" - "Compute Failed"
"Feature_Input_Compute_Error" - "Reference Failures"
"InvalidWPntInput" - "Invalid input"
"NO_TARGET_BODY" - "No target body!"
"ORIGIN_SELECTION_MISSING" - "Origin geometry is missing."
"DRPOINT_COMPUTE_FAILED" - "Failed to evaluate the point due to the invalid input"

This is an optional argument whose default value is "".

message

string

This is not currently supported for custom feature compute errors and will be ignored.

This is an optional argument whose default value is "".

Type	Description
StatusMessage	Returns true if the warning message was successfully added.

StatusMessages.addWarning Method

Description

Syntax

Return Value

Parameters

Version

Name	Type	Description
messageId	string	The ID of a predefined message or if an empty string is provided, the default error message will be used. The displayed message is localized based on the current default language in Fusion. Below is a list of some valid message ID's and the corresponding English message. "API_COMPUTE_ERROR" - "Cannot compute this feature." "API_COMPUTE_WARNING" - "This feature computed with warnings." "CFLANGE_INVALID_GEOM" - "Invalid input sketch curve." "DRAFT_MISSING_FACE_REFERENCES" - "Missing face references" "DRAFT_MISSING_REFERENCE_PLANE" - "Missing reference plane" "FEATURE_ENTITY_TYPE_INVALID" - "Entity type is invalid" "FEATURE_FAILED_TO_CREATE" - "Failed to create feature" "FEATURE_MISSING_INPUTS" - "Missing inputs" "FEATURE_REFERENCE_LOST" - "Reference is lost" "Feature_Compute_Error" - "Compute Failed" "Feature_Input_Compute_Error" - "Reference Failures" "InvalidWPntInput" - "Invalid input" "NO_TARGET_BODY" - "No target body!" "ORIGIN_SELECTION_MISSING" - "Origin geometry is missing." "DRPOINT_COMPUTE_FAILED" - "Failed to evaluate the point due to the invalid input" This is an optional argument whose default value is "".
message	string	This is not currently supported for custom feature compute errors and will be ignored. This is an optional argument whose default value is "".