Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  IDL Reference  >  I/O - Network  >  IDLnetJPIP::GetUuid

IDLnetJPIP::GetUuid

IDLnetJPIP::GetUuid

GetUuid provides a way to get the data field from the specified UUID (Universally Unique Identifier) box. A JPEG2000 file can contain 0 to 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 (uuid).

Note: This method will throw an error if there is a failure. Use a CATCH statement to trap errors.

Syntax


Result = Obj ->[IDLnetJPIP::]GetUuid(Uuid, [, LENGTH=value])

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

UUID is required and must be a 16 byte array. This argument identifies which UUID box to read.

Keywords


LENGTH

LENGTH is an optional output 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.



© 2018 Harris Geospatial Solutions, Inc. |  Privacy Policy
My Account    |    Store    |    Contact Us