Graphics::MeasureString(constWCHAR*,INT,constFont*,constPointF&,constStringFormat*,RectF*) method (gdiplusgraphics.h)

The Graphics::MeasureString method measures the extent of the string in the specified font, format, and layout rectangle.

Syntax

Status MeasureString(
  [in]      const WCHAR        *string,
  [in]      INT                length,
  [in]      const Font         *font,
  [in, ref] const PointF &     origin,
  [in]      const StringFormat *stringFormat,
  [out]     RectF              *boundingBox
);

Parameters

[in] string

Type: const WCHAR*

Pointer to a wide-character string to be measured.

[in] length

Type: INT

Integer that specifies the number of characters in the string array. The length parameter can be set to –1 if the string is null terminated.

[in] font

Type: const Font*

Pointer to a Font object that specifies the family name, size, and style of the font that is applied to the string.

[in, ref] origin

Type: const PointF

Reference to the point at which the string starts.

[in] stringFormat

Type: const StringFormat*

Pointer to a StringFormat object that specifies the layout information, such as alignment, trimming, tab stops, and so forth.

[out] boundingBox

Type: RectF*

Pointer to a RectF object that receives the rectangle that bounds the string.

Return value

Type: Status

If the method succeeds, it returns OK, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Requirements

See also

DrawString Methods

Font

Graphics

PointF

StringFormat