ImgFormat_GetInfo¶

Return the image format’s characteristics.

ImgFormat_GetInfo(formatID) ➔ infoObj

formatID	Text	The image format identifier.
infoObj	Object	The image format information object.

Return the image format’s characteristics as a 4D object.

Parameter formatID is the identifier of the image format. If formatID is not a valid image format identifier or empty, an undefined object is returned.

Some common image format identifiers are “JPEG”, “TIFF”, “PNG”, “PDF, and so on. The list of supported format identifiers can be retrieved with the ImgFormat_GetList plug-in method.

The contents of object infoObj that receives the image format characteristics are described in the following table.

Image Format Info¶
Property name	Type	Description
`ID`	`String`	The identifier of the format.
`Name`	`String`	The name of the format.
`UTI`	`String`	The Universal Type Identifier of the format.
`MIMETypes`	`array string`	A list of MIME types associated with the format.
`Extensions`	`array string`	A list of filename extensions associated with the format.
`CanEncode`	`Boolean`	Set to `True` if the format supports encoding/exporting.
`IsRaster`	`Boolean`	Set to `True` if the format raster-based.
`IsVector`	`Boolean`	Set to `True` if the format vector-based.
`HasThumbnails`	`Boolean`	Set to `True` if the format supports embedded thumbnails.
`HasXMP`	`Boolean`	Set to `True` if the format supports XMP.

Note

This method is a convenience wrapper for the ImgFormat_GetInfo_JSN plug-in method.