CNSImage_GetInfo

Description

The CNSImage_GetInfo function returns information about an image such as the format, width, height, resolution, depth, quality, and size. You can also use the "Field" parameter to retrieve a specific value such as the width of an image.

Return Type

Text

Format

CNSImage_GetInfo ( Image ; Field )

Required Parameters

• Image
  

  A Container field that contains an Image or a Path and File Name to an Image you need the Info of.

Optional Parameters

• Field
  

  A specific Info Item you need. (If this parameter is not defined, all Info Items will be returned. You can specify multiple fields separated by a semicolon. Fields:

  Type
  Width
  Height
  HRes
  VRes
  Depth
  Quality
  FileSize
  DisplayWidth
  DisplayHeight
  Layers
  PathName
  FileName
  Storage
  Format

  Note, the order you specify Info Items in the Field parameter will not change the order the Info Items are returned from the function. The Info Items will always be returned in the same order as the fields are listed above.

Examples

Example 1

Code:

CNSImage_GetInfo( MyImage )

Result:

Returns a return delimited string of information for the image in the "MyImage" container.

Example 2

Code:

CNSImage_GetInfo( MyImage ;"width")

Result:

Returns the width of the image in the "MyImage" container.

Example 3

Code:

CNSImage_GetInfo( MyImage ;"height;width")

Result:

Returns the height and width separated by a return.