Index

CDTEngineV8

FontGetSysStatus

This function returns the current system status for a font or font instance that is in the Font Catalog of the specified Standard Engine instance.

Parameters

ParameterDescription

font_index

Font index of the font or font instance in the Font Catalog.

font_format_id

A valid pointer to the DT_ID_SWORD type that will receive an ID that uniquely identifies the font format of the referenced font or font instance. See FontAddViaStream for a full description of this parameter.

However, if you do not wish to receive the value of the above parameter, you may set this pointer to DV_NULL.

fuid

A pointer to a buffer supplied by your application that will hold the font's 16-byte binary string. This string is expected to uniquely identify the referenced font as specified by your application when the font was added to the Font Catalog. If your application does not wish to receive this string, you may set fuid to DV_NULL. Otherwise, fuid must be a valid pointer to a buffer that will hold a binary sting that is exactly 16 bytes long. Note this is a fixed-width binary string, thus it will always be exactly 16 bytes long and will not be null terminated. Consequently, the size of your buffer does not have to exceed 16 bytes.

See FontAddViaStream for more information on this parameter.

fcnr

A valid pointer to the DT_SWORD type that will receive the font collection number of the referenced font or font instance. See FontAddViaStream for a full description of this parameter.

However, if you do not wish to receive the value of the above parameter, you may set this pointer to DV_NULL.

cmap_id

Reserved for future use; must be a valid pointer to the DT_SWORD type.

If you do not wish to receive the value of the above parameter, you may set this pointer to DV_NULL.

caching

A valid pointer to the DT_ID_UBYTE type that will receive information about the caching scheme associated with the referenced font or font instance. See FontAddViaStream for a full description of this parameter.

However, if you do not wish to receive the value of the above parameter, you may set this pointer to DV_NULL.

hinting

A valid pointer to the DT_ID_UBYTE type that will receive information on whether the referenced font or font instance was added to the Font Catalog as (auto)hinted or non-hinted. See FontAddViaStream for a full description of this parameter.

However, if you do not wish to receive the value of the above parameter, you may set this pointer to DV_NULL.

active

A valid pointer to the DT_ID_UBYTE type that will receive information on whether the specified font or font instance is currently in the active or inactive state. At present, one of the following values can be returned:

  • active = 0 — font or font instance is currently inactive
  • active = 1 — font or font instance is currently active

However, if you do not wish to receive the value of the above parameter, you may set this pointer to DV_NULL.

Return Value

If successful, the function returns 0 or 1. The value 0 indicates that the specified font is not a multiple-master font instance (which means it was added to the Font Catalog using FontAddViaStream or FontAddViaStreams). The value 1 indicates that the specified font is a multiple-master font instance (which means it was added to the font catalog using FontAddAsMMInstance). If not successful, the function returns -1. This can happen if the specified font_index is not a valid font index.



 

Index