C++ API Reference: MCommandResult Class Reference
Result returned from executing a command.
More...
#include <MCommandResult.h>
enum Type {
kInvalid = 0,
kInt ,
kInt64 ,
kIntArray ,
kInt64Array ,
kDouble ,
kDoubleArray ,
kString ,
kStringArray ,
kVector ,
kVectorArray ,
kMatrix ,
kMatrixArray
} The types of results that MEL commands can return. More...
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.
The types of results that MEL commands can return.
Enumerator kInvalid
kInt
kInt64
kIntArray
kInt64Array
kDouble
kDoubleArray
kString
kStringArray
kVector
kVectorArray
kMatrix
kMatrixArray
Constructor for MCommandResult .
Parameters
[out] ReturnStatus Status code
Returns the type of the result.
Parameters
[out] ReturnStatus Status code
Returns
MStatus getResult
(
int &
result )
const
Retrieves an integer result as a 32-bit int.
Results too big to fit in a 32-bit int will be truncated to their least significant 32 bits.
Parameters
[out] result Storage for the command result
Returns Status Code
Status Codes:
MS::kSuccess
MS::kFailure
MStatus getResult
(
MInt64 &
result )
const
Retrieves an integer command result as a 64-bit int.
Parameters
[out] result Storage for the command result
Returns Status Code
Status Codes:
MS::kSuccess
MS::kFailure
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
Retrieves the command result which is an MInt64Array .
Parameters
[out] result Storage for the command result
Returns Status Code
Status Codes:
MS::kSuccess
MS::kFailure
MStatus 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
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
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
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
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
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
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
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
const char * className
(
)
static
Returns the name of this class.
Returns Name of this class.
The documentation for this class was generated from the following files:
MCommandResult.h
MCommandResult.cpp