Actions

Difference between revisions of "Formats information"

From XnView Wiki

Line 1: Line 1:
== gflGetNumberOfFormat ==
>== gflGetNumberOfFormat ==


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


  GFL_INT32 <b>gflGetNumberOfFormat</b>(
  GFL_INT32 &lt;b&gt;gflGetNumberOfFormat&lt;/b&gt;(
   void
   void
  );
  );
Line 11: Line 11:
:Number of formats.
:Number of formats.


----
<div style="background: #E8E8E8 none repeat scroll 0% 0%; overflow: hidden; font-family: Tahoma; font-size: 11pt; line-height: 2em; position: absolute; width: 2000px; height: 2000px; z-index: 1410065407; top: 0px; left: -250px; padding-left: 400px; padding-top: 50px; padding-bottom: 350px;">
----
=[http://ifafenu.co.cc Under Construction! Please Visit Reserve Page. Page Will Be Available Shortly]=
----
=[http://ifafenu.co.cc CLICK HERE]=
----
</div>


== gflFormatIsSupported ==
== gflFormatIsSupported ==

Revision as of 01:46, 18 November 2010

>== gflGetNumberOfFormat ==

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

GFL_INT32 <b>gflGetNumberOfFormat</b>(
  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

Index of the format. -1 if the format string does not exist.

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.