Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 9.1   9.2   9.3   9.4   9.5   10.0   10.1   10.2   10.3   10.4    Statistic  

GMImage.Ping

Pings an image to query metadata.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
GMImage 10.3 Yes Yes Yes Yes Yes
MBS( "GMImage.Ping"; ImageRef; Spec )   More

Parameters

Parameter Description Example value
ImageRef The image reference number. 1
Spec The image specification.
e.g. native file path

Result

Returns OK or error.

Description

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.

This function requires a native path. Use Path.FileMakerPathToNativePath to convert a FileMaker path to a native path if required. If you like to have the user choose the path, you can use FileDialog functions.
For Server be aware that server has limited permissions and may not be able to access all files on a computer.

Examples

Ping picture and show size:

# ping in file Contacts

# 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.Ping"; $img; "/Users/cs/Desktop/test.png" ) ]
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 ]
Else
    Show Custom Dialog [ "Failed" ; $r ]
End If
Set Variable [ $r ; Value: MBS( "GMImage.Release"; $img) ]

See also

Blog Entries

Release notes

Created 14th July 2020, last changed 15th July 2020


GMImage.Opaque   -   GMImage.PingContainer

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins