class MCommandResult

Jump to documentation

public members:

enum	Type Itemize the mel command result types: kInvalid kInt kIntArray kDouble kDoubleArray kString kStringArray kVector kVectorArray kMatrix kMatrixArray
	MCommandResult ( MStatus * ReturnStatus = NULL )
virtual	~MCommandResult ()
Type	resultType ( MStatus * ReturnStatus = NULL) const
MStatus	getResult ( int& result) const
MStatus	getResult ( MIntArray & result) const
MStatus	getResult ( double& result) const
MStatus	getResult ( MDoubleArray & result) const
MStatus	getResult ( MString & result) const NO SCRIPT SUPPORT
MStatus	getResult ( MStringArray & result) const
MStatus	getResult ( MVector & result) const
MStatus	getResult ( MVectorArray & result) const
MStatus	getResult ( MDoubleArray & result, int &numRows, int &numColumns) const

Documentation

Description

MCommandResult collects the result returned by MGlobal::executeCommand. It can either be an int or an array of int or a double or an array of double or a string or an array of string. Use resultType to find out its type and use the appropriate getResult method to retrieve the result.

Functions

MCommandResult:: MCommandResult ( MStatus *ReturnStatus)

Description

Constructor for MCommandResult.

Arguments

• ReturnStatus Status code

MCommandResult:: ~MCommandResult ()

Description

Destructor for MCommandResult.

MCommandResult::Type MCommandResult:: resultType ( MStatus * ReturnStatus) const

Description

Returns the type of the result.

Arguments

• ReturnStatus Status code

Return Value

• MCommandResult::kInt
• MCommandResult::kIntArray
• MCommandResult::kDouble
• MCommandResult::kDoubleArray
• MCommandResult::kString
• MCommandResult::kStringArray
• MCommandResult::kVector
• MCommandResult::kVectorArray
• MCommandResult::kMatrix
• MCommandResult::kInvalid

MStatus MCommandResult:: getResult ( int& result ) const

Description

Retrieves the command result which is an int.

Arguments

• result Storage for the command result

Return Value

• Status Code

Status Codes

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult:: getResult ( MIntArray & result ) const

Description

Retrieves the command result which is an int array.

Arguments

• result Storage for the command result

Return Value

• Status Code

Status Codes

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult:: getResult ( double& result ) const

Description

Retrieves the command result which is a double.

Arguments

• result Storage for the command result

Return Value

• Status Code

Status Codes

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult:: getResult ( MDoubleArray & result ) const

Description

Retrieves the command result which is a double array.

Arguments

• result Storage for the command result

Return Value

• Status Code

Status Codes

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult:: getResult ( MString & result ) const

Description

Retrieves the command result which is a string.

Python Notes

This method is not supported in Python. See the stringResult function which returns a string.

Arguments

• result Storage for the command result

Return Value

• Status Code

Status Codes

• MS::kSuccess
• MS::kFailure

MString MCommandResult:: stringResult ( MStatus * ReturnStatus ) const

Description

Retrieves the command result which is a string.

Arguments

• ReturnStatus Optional status code. See below.

Return Value

• The command result

Status Codes

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult:: getResult ( MStringArray & result ) const

Description

Retrieves the command result which is a string array.

Arguments

• result Storage for the command result

Return Value

• Status Code

Status Codes

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult:: getResult ( MVector & result ) const

Description

Retrieves the command result which is a vector.

Arguments

• result Storage for the command result

Return Value

• Status Code

Status Codes

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult:: getResult ( MVectorArray & result ) const

Description

Retrieves the command result which is a vector array.

Arguments

• vector Storage for the command result

Return Value

• Status Code

Status Codes

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult:: getResult ( MDoubleArray & result, int &numRows, int &numColumns ) const

Description

Retrieves the command result which is a matrix.

Arguments

• result Storage for the content of the matrix (row-based)
• numRows The number of rows in the matrix
• numColumns The number of columns in the matrix

Return Value

• Status Code

Status Codes

• MS::kSuccess
• MS::kFailure

This class has no child classes.