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


Pings an image to query metadata.

Component Version macOS Windows Linux Server iOS SDK
GraphicsMagick 10.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "GMImage.PingContainer"; ImageRef; data )   More


Parameter Description Example
ImageRef The image reference number. 1
data The container value, either a variable or a container field.


Returns OK or error.


Pings an image to query metadata.
Ping is similar to read except only enough of the image is read to determine the image columns, rows, and file size.

See GMImage.GetWidth, GMImage.GetHeight and GMImage.GetXMP.


Ping container to query size:

# you have some dummy image already
Set Variable [ $img ; Value: MBS( "GMImage.New"; "10x10"; "white" ) ]
# read new picture into it
Set Variable [ $r ; Value: MBS( "GMImage.SetMagick"; $img; "png") ]
Set Variable [ $r ; Value: MBS( "GMImage.PingContainer"; $img; Contacts::Photo Container) ]
If [ MBS("IsError") = 0 ]
    Set Variable [ $w ; Value: MBS( "GMImage.GetWidth"; $img ) ]
    Set Variable [ $h ; Value: MBS( "GMImage.GetHeight"; $img ) ]
    Show Custom Dialog [ "Size" ; $w & " x " & $h ]
    Show Custom Dialog [ "Failed" ; $r ]
End If
Set Variable [ $r ; Value: MBS( "GMImage.Release"; $img) ]

See also

Release notes

Blog Entries

This function checks for a license.

Created 14th July 2020, last changed 8th March 2021

GMImage.Ping - GMImage.PopClipPath