MCommandResult Class Reference
[OpenMaya - API module for common classes]

#include <MCommandResult.h>

List of all members.

---

Detailed Description

Result returned from executing a command.

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.

Public Types
enum	Type {    kInvalid = 0, kInt, kIntArray, kDouble,    kDoubleArray, kString, kStringArray, kVector,    kVectorArray, kMatrix, kMatrixArray }
	The types of results that MEL commands can return. More...
Public Member Functions
	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
MString	stringResult (MStatus *ReturnResult=NULL) 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

---

Member Enumeration Documentation

enum MCommandResult::Type

The types of results that MEL commands can return.

Enumerator:

kInvalid
kInt
kIntArray
kDouble
kDoubleArray
kString
kStringArray
kVector
kVectorArray
kMatrix
kMatrixArray

---

Constructor & Destructor Documentation

MCommandResult::MCommandResult

(

MStatus *

ReturnStatus = NULL

)

Constructor for MCommandResult.

Parameters:

[out]

ReturnStatus

Status code

MCommandResult::~MCommandResult

(

)

[virtual]

Destructor for MCommandResult.

---

Member Function Documentation

MCommandResult::Type MCommandResult::resultType

(

MStatus *

ReturnStatus = NULL

)

const

Returns the type of the result.

Parameters:

[out]

ReturnStatus

Status code

Returns:

• 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

Retrieves the command result which is an int.

Parameters:

[out]

result

Storage for the command result

Returns:

Status Code

Status Codes:

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult::getResult

(

MIntArray &

result

)

const

Retrieves the command result which is an int array.

Parameters:

[out]

result

Storage for the command result

Returns:

Status Code

Status Codes:

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult::getResult

(

double &

result

)

const

Retrieves the command result which is a double.

Parameters:

[out]

result

Storage for the command result

Returns:

Status Code

Status Codes:

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult::getResult

(

MDoubleArray &

result

)

const

Retrieves the command result which is a double array.

Parameters:

[out]

result

Storage for the command result

Returns:

Status Code

Status Codes:

• MS::kSuccess
• MS::kFailure

MString MCommandResult::stringResult

(

MStatus *

ReturnStatus = NULL

)

const

Retrieves the command result which is a string.

Parameters:

[out]

ReturnStatus

Optional status code. See below.

Returns:

The command result

Status Codes:

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult::getResult

(

MString &

result

)

const

NO SCRIPT SUPPORT.

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.

Parameters:

[out]

result

Storage for the command result

Returns:

Status Code

Status Codes:

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult::getResult

(

MStringArray &

result

)

const

Retrieves the command result which is a string array.

Parameters:

[out]

result

Storage for the command result

Returns:

Status Code

Status Codes:

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult::getResult

(

MVector &

result

)

const

Retrieves the command result which is a vector.

Parameters:

[out]

result

Storage for the command result

Returns:

Status Code

Status Codes:

• MS::kSuccess
• MS::kFailure

MStatus MCommandResult::getResult

(

MVectorArray &

result

)

const

Retrieves the command result which is a vector array.

Parameters:

[out]

result

Storage for the command result

Returns:

Status Code

Status Codes:

• MS::kSuccess
• MS::kFailure

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

Retrieves the command result which is a matrix.

Parameters:

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

Returns:

Status Code

Status Codes:

• MS::kSuccess
• MS::kFailure