ConstructionPlane.errorOrWarningMessage Property

Parent Object: ConstructionPlane
Defined in namespace "adsk::fusion" and the header file is <Fusion/Construction/ConstructionPlane.h>

Description

Returns the error or warning message in the case where the healthState property returns either WarningFeatureHealthState or ErrorFeatureHealthState. Otherwise this property returns an empty string.

Syntax

"constructionPlane_var" is a variable referencing a ConstructionPlane object.
# Get the value of the property.
propertyValue = constructionPlane_var.errorOrWarningMessage
"constructionPlane_var" Is a variable referencing a ConstructionPlane Object.
#include <Fusion/Construction/ConstructionPlane.h>

// Get the value of the property.
string propertyValue = constructionPlane_var->errorOrWarningMessage();
"constructionPlane_var" Is a variable referencing a ConstructionPlane Object.
// Get the value of the property.
propertyValue = constructionPlane_var.errorOrWarningMessage;

Property Value

This is a read only property whose value is a string.

Samples

Name Description
Construction Plane API Sample

Demonstrates creating construction planes using ConstructionPlaneInput: offset from a profile, angle, tangent, two planes, two edges, three points, three snap points, tangent at a point, and along a path. Also shows reading healthState, errorOrWarningMessage, and renaming planes.

Before running: No open document is required. The script creates a new design, sketches a circle and lines, extrudes a cylinder, then exercises the construction plane APIs on that model. Run from Scripts and Add-Ins (Python/C++/TypeScript) in the DESIGN workspace.

Version

Introduced in version July 2016