class MStringResource

Jump to documentation

public members:

	MStringResource ()
static const MString	getString ( const MStringResourceId &id, MStatus &status)
static MStatus	registerString ( const MStringResourceId &id )
	~MStringResource ()

Documentation

Description

The MStringResource class implements methods for registering and retrieving string values from externally defined string resources. This allows the plug-in to provide localized string resources.

Functions

MStringResource:: MStringResource ()

Description

The Class constructor. Not used as all methods are static.

MStringResource:: ~MStringResource ()

Description

The class destructor. Not used as all methods are static.

const MString MStringResource:: getString ( const MStringResourceId &id, MStatus &status )

Description

Retrieve a string resource using a key value. By default, the string returned will be the default string value provided as part of the string ID and registered via MStringResource::registerString. If a localized value has been provided, it will be returned instead. See also MStringResourceId and MFnPlugin::registerUIString. Arguments

• id Resource id of the string to retrieve.
• status MS::kSuccess if lookup succeeded, otherwise MS::kFailure

  Return Value

  • MS::kSuccess if lookup succeeded, otherwise MS::kFailure
  MStatus MStringResource:: registerString ( const MStringResourceId &id )

  Description

  Register a plugin string resource. The MStringResourceId passed in provides all the information required to register the string and to initialize it to its default value.

  See also MStringResourceId and MFnPlugin::getUIString. Arguments

  • id Resource id associated with the string to register.
  • status MS::kSuccess if lookup succeeded, otherwise MS::kFailure

    Return Value

    • MS::kSuccess if registration succeeded, otherwise MS::kFailure

This class has no child classes.