UNIFONTOBJ_GetInfo routine

The UNIFONTOBJ_GetInfo callback function is provided by the Unidrv driver so that rendering plug-ins can obtain font or glyph information.

Syntax


PFNGETINFO UNIFONTOBJ_GetInfo;

BOOL APIENTRY UNIFONTOBJ_GetInfo(
   struct _UNIFONTOBJ *pUFObj,
   DWORD              dwInfoID,
   PVOID              pData,
   DWORD              dwDataSize,
   PDWORD             pcbNeeded
)
{ ... }

Parameters

pUFObj

Pointer to the UNIFONTOBJ structure received by the function that is making the callback to UNIFONTOBJ_GetInfo. Supplied by the caller.

dwInfoID

Specifies the type of structure pointed to by pData. Supplied by the caller. See the following table.

pData

Pointer to a structure, as indicated in the following table. Supplied by the caller.

dwInfoID ValuepData Structure

UFO_GETINFO_FONTOBJ

GETINFO_FONTOBJ

UFO_GETINFO_GLYPHBITMAP

GETINFO_GLYPHBITMAP

UFO_GETINFO_GLYPHSTRING

GETINFO_GLYPHSTRING

UFO_GETINFO_GLYPHWIDTH

GETINFO_GLYPHWIDTH

UFO_GETINFO_MEMORY

GETINFO_MEMORY

UFO_GETINFO_STDVARIABLE

GETINFO_STDVAR

 

For a summary of structure contents, see the following Remarks section.

dwDataSize

Specifies the size, in bytes, of the buffer pointed to by pData. Supplied by the caller.

pcbNeeded

Pointer to a location that receives the minimum buffer size, in bytes, required to contain the structure identified by dwInfoID. Supplied by the caller.

Return value

If the operation succeeds, the function returns TRUE. Otherwise it returns FALSE.

Remarks

The UNIFONTOBJ_GetInfo callback function allows a rendering plug-in to call back into Unidrv to obtain font or glyph information from GDI, needed for handling customized font management operations.

A rendering plug-in receives the UNIFONTOBJ_GetInfo function's address in the UNIFONTOBJ structure that is passed to the font customization methods.

The type of information returned by the function is dependent on the input arguments. The caller supplies values for dwInfoID, pData, and dwDataSize to indicate the type of information wanted. The following table summarizes the types of information returned. For more information, see the structure descriptions.

pData StructureReturned Information

GETINFO_FONTOBJ

A FONTOBJ structure describing the current font.

GETINFO_GLYPHBITMAP

A single glyph bitmap.

GETINFO_GLYPHSTRING

An array of glyph specifiers in a specified format.

GETINFO_GLYPHWIDTH

Total width of a set of glyphs.

GETINFO_MEMORY

Amount of available printer memory remaining.

GETINFO_STDVAR

The current value for one or more of Unidrv's standard variables.

 

If the buffer described by pData and dwDataSize is too small to receive the structure indicated by dwInfoID, the function loads the required buffer size into the location pointed by pcbNeeded and returns FALSE.

Requirements

Target platform

Header

Printoem.h (include Printoem.h)

 

 

Send comments about this topic to Microsoft

Show: