Image.getRenderInfo (Method)

Returns a detailed ImageInfo structure containing information about the image needed for rendering.

Returns:

ImageInfo (struct)

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

Field Name	Type	Description
AltText	PlainText	Alternate text of the image.
FileName	Filename_EmptyString	Filename of the image.
GalleryID	ImageGalleryID_0	ID of the gallery to which the image belongs.
ImageFound	Boolean	Boolean value indicating if the image could be found or not.
ImageFound_webP	Boolean	Boolean value indicating if thewebP version of the image could be found or not if webP is enabled.
ImageID	Integer	ID of the image.
Images	ResolvedImageURLCollection	An array of all the sizes available for the image arranged from highest to lowest.
ImageSizes	ResolvedImageURLAssocArray	A structure of available sizes of the imge.
Metadata	Struct	Metadata for the image.
MIMEType	String	MIME type for the image.
OrigHeight	Integer	Original height of the image.
OrigSize	Integer	Original size of the image.
OrigWidth	Integer	Original width of the image.
RenderWebP	Boolean	Boolean value indicating if rendering of webP is enabled for the gallery in which the image resides.
ResolvedURL	ResolvedImageURL	Resolved URLs for the image.
SubsiteID	SubsiteID	ID of the subsite where the image resides.
TitleText	PlainText	Title text for the image.

Arguments:

Name	Type	Required	Description
imageID	ImageID	Required	The image's unique ID.

Context:

License Requirements	None
Permission Requirements	ContributorOrServerCode
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:

None

Notes:

None