CHOOSEFONT

3.1

#include <commdlg.h>

typedef struct tagCHOOSEFONT {  /* cf */
    DWORD           lStructSize;
    HWND            hwndOwner;
    HDC             hDC;
    LOGFONT FAR*    lpLogFont;
    int             iPointSize;
    DWORD           Flags;
    COLORREF        rgbColors;
    LPARAM          lCustData;
    UINT (CALLBACK* lpfnHook)(HWND, UINT, WPARAM, LPARAM);
    LPCSTR          lpTemplateName;
    HINSTANCE       hInstance;
    LPSTR           lpszStyle;
    UINT            nFontType;
    int             nSizeMin;
    int             nSizeMax;

} CHOOSEFONT;

The CHOOSEFONT structure contains information that the system uses to initialize the system-defined Font dialog box. After the user chooses the OK button to close the dialog box, the system returns information about the user's selection in this structure.

Members

lStructSize

Specifies the length of the structure, in bytes. This member is filled on input.

hwndOwner

Identifies the window that owns the dialog box. This member can be any valid window handle, or it should be NULL if the dialog box is to have no owner.

If the CF_SHOWHELP flag is set, hwndOwner must identify the window that owns the dialog box. The window procedure for this owner window receives a notification message when the user chooses the Help button. (The identifier for the notification message is the value returned by the RegisterWindowMessage function when HELPMSGSTRING is passed as its argument.)

This member is filled on input.

hDC

Identifies either the device context or the information context of the printer for which fonts are to be listed in the dialog box. This member is used only if the Flags member specifies the CF_PRINTERFONTS flag; otherwise, this member is ignored.

This member is filled on input.

lpLogFont

Points to a LOGFONT structure. If an application initializes the members of this structure before calling ChooseFont and sets the CF_INITTOLOGFONTSTRUCT flag, the ChooseFont function initializes the dialog box with the font that is the closest possible match. After the user chooses the OK button to close the dialog box, the ChooseFont function sets the members of the LOGFONT structure based on the user's final selection.

This member is filled on input and output.

iPointSize

Specifies the size of the selected font, in tenths of a point. The ChooseFont function sets this value after the user chooses the OK button to close the dialog box.

Flags

Specifies the dialog box initialization flags. This member can be a combination of the following values:

These flags may be set when the structure is initialized, except where specified.

rgbColors

If the CF_EFFECTS flag is set, this member contains the red, green, and blue (RGB) values the ChooseFont function should use to set the text color. After the user chooses the OK button to close the dialog box, this member contains the RGB values of the color the user selected.

This member is filled on input and output.

lCustData

Specifies application-defined data that the application passes to the hook function. The system passes a pointer to the CHOOSEFONT data structure in the lParam parameter of the WM_INITDIALOG message; the lCustData member can be retrieved using this pointer.

lpfnHook

Points to a hook function that processes messages intended for the dialog box. To enable the hook function, an application must specify the CF_ENABLEHOOK value in the Flags member; otherwise, the system ignores this structure member. The hook function must return zero to pass a message that it didn't process back to the dialog box procedure in COMMDLG.DLL. The hook function must return a nonzero value to prevent the dialog box procedure in COMMDLG.DLL from processing a message it has already processed.

This member is filled on input.

lpTemplateName

Points to a null-terminated string that specifies the name of the resource file for the dialog box template to be substituted for the dialog box template in COMMDLG.DLL. An application can use the MAKEINTRESOURCE macro for numbered dialog box resources. This member is used only if the Flags member specifies the CF_ENABLETEMPLATE flag; otherwise, this member is ignored.

This member is filled on input.

hInstance

Identifies a data block that contains the dialog box template specified by the lpTemplateName member. This member is used only if the Flags member specifies the CF_ENABLETEMPLATE or the CF_ENABLETEMPLATEHANDLE flag; otherwise, this member is ignored.

This member is filled on input.

lpszStyle

Points to a buffer that contains a style-description string for the font. If the CF_USESTYLE flag is set, the ChooseFont function uses the data in this buffer to initialize the Font Style box. When the user chooses the OK button to close the dialog box, the ChooseFont function copies the string in the Font Style box into this buffer.

The buffer pointed to by lpszStyle must be at least LF_FACESIZE bytes long.

This member is filled on input and output.

nFontType

Specifies the type of the selected font. This member can be one or more of the values in the following list:

nSizeMin

Specifies the minimum point size that a user can select. The ChooseFont function will recognize this member only if the CF_LIMITSIZE flag is set.

This member is filled on input.

nSizeMax

Specifies the maximum point size that a user can select. The ChooseFont function will recognize this member only if the CF_LIMITSIZE flag is set.

This member is filled on input.

See Also

ChooseFont