ImageGallery.getSizeList (Method)
Returns a list of image gallery size specifications.
Returns:
ImageGallery_GetSizeList_Result (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
Description | PlainText_NonNull_2000 | Description of an image gallery size specification. |
GalleryID | ImageGalleryID | ID of an image gallery to which the size specification is associated. |
Height | NonNegativeInteger | Height specified in the image gallery size specification. |
ID | ImageGallerySizeID | ID of an image gallery size specification. |
Name | PlainText_NonNull_125 | Name of an image gallery size specification. |
Width | NonNegativeInteger | Width specified in the image gallery size specification. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
id | ImageGalleryID_0 | Optional. Defaults to '0'. | ID of an image gallery or 0 to return all size specifications for all image galleries. |
sizeID | ImageGallerySizeID_0 | Optional. Defaults to '0'. | ID of an image gallery specification or 0 to return all size specifications for an image gallery. |
orderBy | SQLOrderByClause | Optional. Defaults to 'Name ASC'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
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 |
---|---|
89501 | The orderBy argument must be in the form {ColumnName} [Direction] where ColumnName must be Name, Description, Width or Height. Direction is optional with values of ASC or DESC. |
Notes:
None