Actions

Difference between revisions of "Formats information"

From XnView Wiki
Line 3: Line 3:
The gflGetNumberOfFormat function gets the number of formats available in GFL.  
The gflGetNumberOfFormat function gets the number of formats available in GFL.  


  GFL_INT32 gflGetNumberOfFormat(
  GFL_INT32 <b>gflGetNumberOfFormat</b>(
&nbsp;void
  void
  );
  );


Line 16: Line 16:
The gflFormatIsSupported function determines if a format is available in GFL.  
The gflFormatIsSupported function determines if a format is available in GFL.  


  GFL_BOOL gflFormatIsSupported(
  GFL_BOOL <b>gflFormatIsSupported</b>(
&nbsp;const char* name
  const char* name
  );
  );


Line 34: Line 34:
The gflGetFormatNameByIndex function returns name of a format's index.  
The gflGetFormatNameByIndex function returns name of a format's index.  


  const char* gflGetFormatNameByIndex(
  const char* <b>gflGetFormatNameByIndex</b>(
&nbsp;GFL_INT32 index
  GFL_INT32 index
  );
  );


Line 51: Line 51:
The gflGetFormatIndexByName function returns index of a format's name.  
The gflGetFormatIndexByName function returns index of a format's name.  


  GFL_INT32 gflGetFormatIndexByName(
  GFL_INT32 <b>gflGetFormatIndexByName</b>(
&nbsp;const char* name
  const char* name
  );
  );


Line 69: Line 69:
The gflFormatIsReadableByIndex function determines if a format is readable with its index.  
The gflFormatIsReadableByIndex function determines if a format is readable with its index.  


  GFL_BOOL gflFormatIsReadableByIndex(
  GFL_BOOL <b>gflFormatIsReadableByIndex</b>(
&nbsp;GFL_INT32 index
  GFL_INT32 index
  );
  );


Line 86: Line 86:
The gflFormatIsReadableByName function determines if a format is readable with its name.  
The gflFormatIsReadableByName function determines if a format is readable with its name.  


  GFL_BOOL gflFormatIsReadableByName(
  GFL_BOOL <b>gflFormatIsReadableByName</b>(
&nbsp;const char * name
  const char * name
  );
  );


Line 103: Line 103:
The gflFormatIsWritableByIndex function determines if a format is writable with its index.  
The gflFormatIsWritableByIndex function determines if a format is writable with its index.  


  GFL_BOOL gflFormatIsWritableByIndex(
  GFL_BOOL <b>gflFormatIsWritableByIndex</b>(
&nbsp;GFL_INT32 index
  GFL_INT32 index
  );
  );


Line 120: Line 120:
The gflFormatIsWritableByName function determines if a format is writable with its name.  
The gflFormatIsWritableByName function determines if a format is writable with its name.  


  GFL_BOOL gflFormatIsWritableByName(
  GFL_BOOL <b>gflFormatIsWritableByName</b>(
&nbsp;const char* name
  const char* name
  );
  );


Line 137: Line 137:
The gflGetFormatDescriptionByIndex function returns the label of a format's index.  
The gflGetFormatDescriptionByIndex function returns the label of a format's index.  


  const char* gflGetFormatDescriptionByIndex(
  const char* <b>gflGetFormatDescriptionByIndex</b>(
&nbsp;GFL_INT32 index
  GFL_INT32 index
  );
  );


Line 154: Line 154:
The gflGetFormatDescriptionByName function returns the label of a format's name.  
The gflGetFormatDescriptionByName function returns the label of a format's name.  


  const char* gflGetFormatDescriptionByName(
  const char* <b>gflGetFormatDescriptionByName</b>(
&nbsp;const char* name
  const char* name
  );
  );


Line 171: Line 171:
The gflGetDefaultFormatSuffixByIndex function returns the default extension of a format's index.  
The gflGetDefaultFormatSuffixByIndex function returns the default extension of a format's index.  


  const char* gflGetDefaultFormatSuffixByIndex(
  const char* <b>gflGetDefaultFormatSuffixByIndex</b>(
&nbsp;GFL_INT32 index
  GFL_INT32 index
  );
  );


Line 188: Line 188:
The gflGetDefaultFormatSuffixByName function returns the default extension of a format's name.  
The gflGetDefaultFormatSuffixByName function returns the default extension of a format's name.  


  const char* gflGetDefaultFormatSuffixByName(
  const char* <b>gflGetDefaultFormatSuffixByName</b>(
&nbsp;const char* name
  const char* name
  );
  );


Line 205: Line 205:
The gflGetFormatInformationByIndex function retrieves all informations of a format's index.  
The gflGetFormatInformationByIndex function retrieves all informations of a format's index.  


  GFL_ERROR gflGetFormatInformationByIndex(
  GFL_ERROR <b>gflGetFormatInformationByIndex</b>(
&nbsp;GFL_INT32 index,   
  GFL_INT32 index,   
&nbsp;GFL_FORMAT_INFORMATION* informations
  GFL_FORMAT_INFORMATION* informations
  );
  );


Line 225: Line 225:
The gflGetFormatInformationByName function retrieves all informations of a format's name.  
The gflGetFormatInformationByName function retrieves all informations of a format's name.  


  GFL_ERROR gflGetFormatInformationByName(
  GFL_ERROR <b>gflGetFormatInformationByName</b>(
&nbsp;const char* name,   
  const char* name,   
&nbsp;GFL_FORMAT_INFORMATION* informations
  GFL_FORMAT_INFORMATION* informations
  );
  );


Revision as of 14:13, 23 September 2009

gflGetNumberOfFormat

The gflGetNumberOfFormat function gets the number of formats available in GFL. 

GFL_INT32 gflGetNumberOfFormat(
  void
);

Return value

Number of formats.


gflFormatIsSupported

The gflFormatIsSupported function determines if a format is available in GFL. 

GFL_BOOL gflFormatIsSupported(
  const char* name
);

Parameters

name
Pointer to a null-terminated string that contains the name of the format.

Return value

GFL_FALSE or GFL_TRUE.


gflGetFormatNameByIndex

The gflGetFormatNameByIndex function returns name of a format's index. 

const char* gflGetFormatNameByIndex(
  GFL_INT32 index
);

Parameters

index
Index of the format.

Return value

Pointer to a null-terminated string that contains name of the format. NULL if there is an error.

gflGetFormatIndexByName

The gflGetFormatIndexByName function returns index of a format's name. 

GFL_INT32 gflGetFormatIndexByName(
  const char* name
);

Parameters

name
Pointer to a null-terminated string that contains the name of the format.

Return value

Pointer to a null-terminated string that contains the name of the format. NULL if there is an error.


gflFormatIsReadableByIndex

The gflFormatIsReadableByIndex function determines if a format is readable with its index. 

GFL_BOOL gflFormatIsReadableByIndex(
  GFL_INT32 index
);

Parameters

index
Index of format.

Return value

GFL_FALSE or GFL_TRUE.


gflFormatIsReadableByName

The gflFormatIsReadableByName function determines if a format is readable with its name. 

GFL_BOOL gflFormatIsReadableByName(
  const char * name
);

Parameters

name
Pointer to a null-terminated string that contains the name of the format.

Return value

GFL_FALSE or GFL_TRUE.


gflFormatIsWritableByIndex

The gflFormatIsWritableByIndex function determines if a format is writable with its index. 

GFL_BOOL gflFormatIsWritableByIndex(
  GFL_INT32 index
);

Parameters

index
Index of the format.

Return value

GFL_FALSE or GFL_TRUE.


gflFormatIsWritableByName

The gflFormatIsWritableByName function determines if a format is writable with its name. 

GFL_BOOL gflFormatIsWritableByName(
  const char* name
);

Parameters

name
Pointer to a null-terminated string that contains the name of the format.

Return value

GFL_FALSE or GFL_TRUE.


gflGetFormatDescriptionByIndex

The gflGetFormatDescriptionByIndex function returns the label of a format's index. 

const char* gflGetFormatDescriptionByIndex(
  GFL_INT32 index
);

Parameters

index
Index of the format.

Return value

Pointer to a null-terminated string that contains the label. NULL if there is an error.


gflGetFormatDescriptionByName

The gflGetFormatDescriptionByName function returns the label of a format's name. 

const char* gflGetFormatDescriptionByName(
  const char* name
);

Parameters

name
Pointer to a null-terminated string that contains the name of the format.

Return value

Pointer to a null-terminated string that contains the label. NULL if there is an error.


gflGetDefaultFormatSuffixByIndex

The gflGetDefaultFormatSuffixByIndex function returns the default extension of a format's index. 

const char* gflGetDefaultFormatSuffixByIndex(
  GFL_INT32 index
);

Parameters

index
Index of the format.

Return value

Pointer to a null-terminated string that contains the default extension. NULL if there is an error.


gflGetDefaultFormatSuffixByName

The gflGetDefaultFormatSuffixByName function returns the default extension of a format's name. 

const char* gflGetDefaultFormatSuffixByName(
  const char* name
);

Parameters

name
Pointer to a null-terminated string that contains the name of the format.

Return value

Pointer to a null-terminated string that contains the default extension. NULL if there is an error.


gflGetFormatInformationByIndex

The gflGetFormatInformationByIndex function retrieves all informations of a format's index. 

GFL_ERROR gflGetFormatInformationByIndex(
  GFL_INT32 index,  
  GFL_FORMAT_INFORMATION* informations
);

Parameters

index
Index of the format.
informations
Pointer to a GFL_FORMAT_INFORMATION structure.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.


gflGetFormatInformationByName

The gflGetFormatInformationByName function retrieves all informations of a format's name. 

GFL_ERROR gflGetFormatInformationByName(
  const char* name,  
  GFL_FORMAT_INFORMATION* informations
);

Parameters

name
Pointer to a null-terminated string that contains the name of the format.
informations
Pointer to a GFL_FORMAT_INFORMATION structure.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.
Retrieved from "https://www.xnview.com/wiki/index.php?title=Formats_information&oldid=161"