Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Return the status of an image source.

Component Version macOS Windows Linux Server iOS SDK
CGImageSource 3.4 ✅ Yes ❌ No ❌ No ✅ Yes, on macOS ✅ Yes
MBS( "CGImageSource.Status"; Ref { ; Index } )   More


Parameter Description Example Flags
Ref The image source reference number returned by CGImageSource.CreateWithData, CGImageSource.CreateWithPath or CGImageSource.CreateWithURL $ref
Index The index of the image to query. -1 for global properties. Else a number from 0 to CGImageSource.Count-1. 0 Optional


Returns status number or error message.


Return the status of an image source.

Possible status values:
kCGImageStatusUnexpectedEOF-5The end of the file was encountered unexpectedly.
kCGImageStatusInvalidData-4The data is not valid.
kCGImageStatusUnknownType-3The image is an unknown type.
kCGImageStatusReadingHeader-2In the process of reading the header.
kCGImageStatusIncomplete-1The operation is not complete
kCGImageStatusComplete0The operation is complete.


Checks status:

Set Variable [ $img ; Value: MBS( "CGImageSource.CreateWithData"; test::input ) ]
Show Custom Dialog [ "Status" ; MBS( "CGImageSource.Status"; $img; 0) ]
Set Variable [ $r ; Value: MBS( "CGImageSource.Release"; $img ) ]

See also

This function checks for a license.

Created 18th August 2014, last changed 5th January 2018

CGImageSource.SetProperty - CGImageSource.SupportedExportTypes