convertToSpecifiedUnits method

  • Article

[This documentation is preliminary and is subject to change.]

Changes the stored unit identifier to the specified type.

Scalable Vector Graphics: Basic Data Types and Interfaces, Section 4.5.11Internet Explorer 9

Syntax

HRESULT retVal = object.convertToSpecifiedUnits(unitType);

Standards information

Parameters

  • unitType [in]
    Type: short

    The unit type to switch to (for example, SVG_ANGLETYPE_DEG or SVG_LENGTHTYPE_MM).

Return value

Type: HRESULT

This method can return one of these values.

Return code Description
W3CException_DOM_NOT_SUPPORTED_ERR

The requested operation is not supported.
W3CException_DOM_NO_MODIFICATION_ALLOWED_ERR

An attempt is made to modify an object that cannot be changed.

 

Remarks

The convertToSpecifiedUnits method preserves the same underlying stored value, but it resets the stored unit identifier to the specified unitType type. The unitType, valueInSpecifiedUnits, and valueAsString objects might be modified when you call this method.

 

 

Build date: 1/26/2012