LabWindows/CVI

Content Type
Programming Language
Current manual
Table of Contents

GetMetaFontInfoWithCharacterSet

GetMetaFontInfoWithCharacterSet

int GetMetaFontInfoWithCharacterSet (const char metaFontName[], char typeFace[], int *bold, int *underline, int *strikeOut, int *italic, int *size, int *angle, int *characterSet);

Purpose

This function returns the typeface, size, orientation angle, character set, and font style of the specified metafont.

LabWindows/CVI includes several predefined metafonts. You can create additional metafonts by calling the CreateMetaFont, CreateMetaFontEx, or CreateMetaFontWithCharacterSet functions in the User Interface Library.

Note  This function assumes that the metafont name you pass is a valid metafont. You can use the IsMetaFont function to determine if a particular font name belongs to a metafont.

Parameters

Input
Name Type Description
metaFontName const char[] The metafont for which to get information.

metaFontName can be a predefined NI metafont or a user-defined metafont saved by a previous call to functions such as CreateMetaFont and CreateMetaFontEx.

The following are NI metafonts:

Predefined metafonts—Contain typeface information, point size, and text styles such as bold, underline, italic, and strikeout. These metafonts are used in the LabWindows/CVI environment. The predefined metafonts are VAL_MENU_META_FONT, VAL_DIALOG_META_FONT, VAL_EDITOR_META_FONT, VAL_APP_META_FONT, and VAL_MESSAGE_BOX_META_FONT.

LabWindows/CVI-supplied metafonts—Use typefaces that are not native to the operating system. These metafonts are installed while LabWindows/CVI is running. The LabWindows/CVI-supplied metafonts are VAL_7SEG_META_FONT and VAL_SYSTEM_META_FONT.
Output
Name Type Description
typeFace char [] The typeface name for the specified metafont. This buffer must be at least 256 characters long to hold all possible typeface names.

Pass 0 (NULL) for this parameter if you do not need this information.
bold int Returns whether the specified metafont has the bold font style attribute set.

Pass 0 (NULL) for this parameter if you do not need this information.
underline int Returns whether the specified metafont has the underline font style attribute set.

Pass 0 (NULL) for this parameter if you do not need this information.
strikeOut int Returns whether the specified metafont has the strikeout font style attribute set.

Pass 0 (NULL) for this parameter if you do not need this information.
italic int Returns whether the specified metafont has the italic font style attribute set.

Pass 0 (NULL) for this parameter if you do not need this information.
size int Returns the point size of the specified metafont.

Pass 0 (NULL) for this parameter if you do not need this information.
angle int Returns the angle of the specified metafont.

Pass 0 (NULL) for this parameter if you do not need this information.
characterSet int Returns the character set of the specified metafont.

Pass 0 (NULL) for this parameter if you do not need this information.

Return Value

Name Type Description
status int Returns zero if the function was succesful, or a negative error code if the function failed.

The possible negative error codes are:

–1 to –999 A User Interface Library error code. (Constants are available in userint.h.)

A description of any of these error codes can be obtained using the GetGeneralErrorString function in the toolbox.fp instrument driver.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 9.0 and later

Was this information helpful?