ImageGallery.getImageFileName (Method)

Structure of image filenames for the provided base file name of an image, depending on the gallery size restrictions and the provided dimensions. Width, height, and percentage cannot all be 0. Width and height can either be numeric, or a range in the form minimum-maximum. Percentage is ignored if width and height are both passed.

Returns:

ImageGallery_GetImageFileName_Struct (struct)

Each row of the returned query results has the following fields:

Field Name Type Description
FileName Filename_EmptyString Name of the image file.
WebPFileName Filename_EmptyString Name of the webP version of the image file.

Arguments:

Name Type Required Description
baseFileName PlainText_NonNull Required Base filename of the image.
id ImageGalleryID Required Image gallery ID in which the image resides.
width String Required Width of the image in pixels, a range in the form minimum-maximum, or 0 to ignore. Width, height, and percentage cannot all be 0.
height String Required Height of the image in pixels, a range in the form minimum-maximum, or 0 to ignore. Width, height, and percentage cannot all be 0.
percentage NonNegativeInteger Optional. Defaults to '0'. Percentage size of the image, or 0 to ignore. Width, height, and percentage cannot all be 0.

Context:

License Requirements (none)
Permission Requirements (none)
Deny Context (none)
Require Context (none)
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization This method may be customized at the site level

Error Codes:

Code Error Message
89509 Height, Width and Percentage cannot all be zero.
89510 $1 of an image for the provided image gallery cannot be zero.

Notes:

None