8.10. tsImageGetFormat
Syntax
Pascal
function tsImageGetFormat(ImageID: tsImageID): tsEnum;
C/C++
tsEnum tsImageGetFormat(tsImageID ImageID);
Description
This function queres the format of the image. For an complete list of all supported formats look in the format table. If the image is empty the format will be TS_FORMAT_EMPTY.
![[Tip]](images/tip.png)
|
Tip |
|---|---|
|
This function calls tsImageGetInfo internally. If you need more than one information from an font reduce overhead and call tsImageGetInfo instead. |
|
Params
- ImageID
-
The ImageID from which the infos will be quered.
Return Value
Return value is the format of the image. For an complete list of all formats
Error Codes
- TS_NO_ACTIVE_CONTEXT
-
If there was no context bound.
- TS_INVALID_VALUE
-
This will happen if you pass an invalid ImageID to this function.