IDLffJPEG2000::GetUUID

The IDLffJPEG2000::GetUUID function method allows you to get the data field from the specified UUID box.

A JPEG2000 file can contain 0-n number of UUID boxes. Each UUID box in a JPEG2000 file is made up of a UUID field and a user data field. A UUID box allows the user to store application specific data inside a JPEG2000 file using a universally unique identifier.

Syntax

Data = Obj->[IDLffJPEG2000::]GetUUID(UUID [, LENGTH=length])

Return Value

Returns one of the following:

• a scalar zero when the passed in UUID is not found in the file
• a byte array containing the data found in the data field of the UUID box.
• a scalar zero when the passed UUID is found in the file but does not contain any data (i.e. the data field is empty).

Arguments

UUID

The UUID argument is required. The UUID argument must be a 16 byte array.

Keywords

LENGTH

Length is an optional keyword. If present, the length variable will be set to the number of bytes in the returned data array. If present and the requested UUID is not found, length will be 0. If present and the requested UUID is found but does not contain any data (i.e. the data field is empty), the length will be -1.

Version History

6.2	Introduced