StatusMessages.item Method

Parent Object: StatusMessages

PreviewThis 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.


Defined in namespace "adsk::core" and the header file is <Core/Application/StatusMessages.h>

Description

Returns the specified status message using an index into the collection.

Syntax

"statusMessages_var" is a variable referencing a StatusMessages object.
returnValue = statusMessages_var.item(index)
"statusMessages_var" is a variable referencing a StatusMessages object.

#include <Core/Application/StatusMessages.h>

returnValue = statusMessages_var->item(index);

Return Value

Type Description
StatusMessage Returns the specified StatusMessage or null if an invalid index was specified.

Parameters

Name Type Description
index uinteger The index of the status message within the collection to return. The first item in the collection has an index of 0.

Version

Introduced in version July 2021