NAME¶

XmConvertStringToUnits — A function that converts a string specification to a unit value

SYNOPSIS¶

#include <Xm/Xm.h>
int XmConvertStringToUnits(
Screen *screen,
String spec,
int orientation,
int to_type,
XtEnum *parse_error);

DESCRIPTION¶

XmConvertStringToUnits converts a string specification value and returns the converted value as the return value from the function. This function uses the specified screen's resolution to compute the number of units for the string specification.

screen

Specifies the screen whose resolution is to be used for the computation.

spec

Specifies the string, in <floating value><unit> format, to be converted.

orientation

Specifies whether the converter uses the horizontal or vertical screen resolution when performing the conversion. The orientation parameter can have values of XmHORIZONTAL or XmVERTICAL.

to_type

Converts the value to the unit type specified. Refer to the XmNunitType resource of the XmGadget, XmManager, or XmPrimitive reference page. This parameter can have one of the following values:

parse_error

Specifies if a parsing error occurred. This is set to a value of True indicates that an error occurred, a value of False to indicate no error.

RETURN¶

Returns the converted value. If a NULL screen, incorrect orientation, or incorrect unit_type is supplied as parameter data, or if a parsing error occurred, 0 (zero) is returned.

RELATED¶

XmConvertUnits(3), XmSetFontUnits(3), and XmScreen(3).