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

#include <MCommonSystemUtils.h>

List of all members.


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.

Static Public Member Functions

static MString getEnv (const MString &variable, MStatus *ResultStatus=NULL)
static MStatus putEnv (const MString &variable, const MString &value)
static MStatus makeDirectory (const MString &path)
static MStatus getEnv (const MString &variable, MString &result)
 NO SCRIPT SUPPORT.


Member Function Documentation

MString MCommonSystemUtils::getEnv ( const MString variable,
MStatus ReturnStatus = NULL 
) [static]

This method is used to access user environment variables.

Parameters:
[in] variable the user environment variable
[out] ReturnStatus Status 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.

MStatus MCommonSystemUtils::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] variable the environment variable
[in] value the 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

MStatus MCommonSystemUtils::makeDirectory ( const MString path  )  [static]

This method is used to create a directory.

Parameters:
[in] path the path of the new directory
Returns:

MStatus MCommonSystemUtils::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] variable the user environment variable
[out] result variable 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.


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6