C++ API Reference
Static Public Member Functions | List of all members
MCommonSystemUtils Class Reference
OpenMaya - API module for common classes

OS functionality. More...

#include <MCommonSystemUtils.h>

Static Public Member Functions

static MString getEnv (const MString &variable, MStatus *ResultStatus=NULL)
 This method is used to access user environment variables. More...
 
static MStatus putEnv (const MString &variable, const MString &value)
 This method can be used to create a new environment variable or update the value of an existing environment variable. More...
 
static MStatus makeDirectory (const MString &path)
 This method is used to create a directory. More...
 
static MStatus getEnv (const MString &variable, MString &result)
 NO SCRIPT SUPPORT. More...
 
static const char * className ()
 Returns the name of this class. More...
 

Detailed Description

OS functionality.

Methods for getting and setting environment variables, make directories etc.

This class provides some standard Operating System functionality that is available from MEL. These methods can be called instead of invoking MEL through the MGlobal class.

NOTE: These methods are provided as a convenience. It would be more efficient to call directly into the operating system than to use the methods of this class.

Member Function Documentation

MString getEnv ( const MString &  variable,
MStatus *  ReturnStatus = NULL 
)
static

This method is used to access user environment variables.

Parameters
[in]variablethe user environment variable
[out]ReturnStatusStatus Code. See below.
Returns
  • MS::kSuccess getting the environment variable worked
  • MS::kFailure failed to get the environment variable, variable length < 1
NOTE: getting an unset environment variable will not return an error.
Examples:
autoLoader/threadData.cpp, and cgFx/cgfxProfile.cpp.
MStatus putEnv ( const MString &  variable,
const MString &  value 
)
static

This method can be used to create a new environment variable or update the value of an existing environment variable.

Parameters
[in]variablethe environment variable
[in]valuethe value to set the environment variable to
Returns
  • MS::kSuccess setting the enviroment variable worked
  • MS::kFailure setting the environment variable failed, variable length < 1
Examples:
autoLoader/threadData.cpp.
MStatus makeDirectory ( const MString &  path)
static

This method is used to create a directory.

Parameters
[in]paththe path of the new directory
Returns
  • MS::kSuccess created new directory
  • MS::kFailure failed to create new directory( invalid path )
OPENMAYA_MAJOR_NAMESPACE_OPEN MStatus getEnv ( const MString &  variable,
MString &  result 
)
static

NO SCRIPT SUPPORT.

This method is used to access user environment variables.

Python Notes

This method is not supported in Python. Please see the one which returns a string

Parameters
[in]variablethe user environment variable
[out]resultvariable value
Returns
  • MS::kSuccess getting the environment variable worked
  • MS::kFailure failed to get the environment variable, variable length < 1
NOTE: getting an unset environment variable will not return an error.
const char * className ( )
static

Returns the name of this class.

Returns
The name of this class.
The documentation for this class was generated from the following files: