LFileSettings::GetDefaultJ2KOptions

#include "ltwrappr.h"

static L_INT LFileSettings::GetDefaultJ2KOptions(pOptions, uStructSize)

pFILEJ2KOPTIONS pOptions;

/* pointer to a structure */

L_UINT uStructSize;

/* size of the structure */

Gets the default options for saving JP2 or J2K files.

Parameter

Description

pOptions

Pointer to a structure to be updated with the default options used when saving JP2 or J2K files.

uStructSize

Size of the structure pointed to by pOptions. Use the sizeof() macro to calculate this value.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Required DLLs and Libraries

LTFIL
File format DLLs

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

LFileSettings::GetJ2KOptions, LFileSettings::SetJ2KOptions, Class Members

Topics:

Raster Image Functions: Saving Files

 

Programming with JPEG 2000 Features

Example

This example will reset the current JPEG2000 options to their default values.

L_INT LFileSettings__GetDefaultJ2KOptionsExample() 
{
   L_INT nRet;
   FILEJ2KOPTIONS J2KOptions;
   // get the default values.
   nRet = LFileSettings::GetDefaultJ2KOptions(&J2KOptions, sizeof(FILEJ2KOPTIONS));
   if(nRet != SUCCESS)
      return nRet;
   // make the default values the current values.
   // The next time a JPEG2000 file is saved, it will be saved using the default options 
   nRet = LFileSettings::SetJ2KOptions(&J2KOptions); 
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}