Difference between revisions of "Formats information"
From XnView Wiki
| (4 intermediate revisions by 3 users not shown) | |||
| Line 62: | Line 62: | ||
'''Return value''' | '''Return value''' | ||
: | :Index of the format. -1 if the format string does not exist. | ||
== gflFormatIsReadableByIndex == | == gflFormatIsReadableByIndex == | ||
| Line 87: | Line 86: | ||
GFL_BOOL <b>gflFormatIsReadableByName</b>( | GFL_BOOL <b>gflFormatIsReadableByName</b>( | ||
const char * name | const char* name | ||
); | ); | ||
| Line 97: | Line 96: | ||
'''Return value''' | '''Return value''' | ||
:GFL_FALSE or GFL_TRUE. | :GFL_FALSE or GFL_TRUE. | ||
== gflFormatIsWritableByIndex == | == gflFormatIsWritableByIndex == | ||
| Line 239: | Line 237: | ||
'''Return value''' | '''Return value''' | ||
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]]. | :The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]]. | ||
[[Category: GFLSDK Reference Manual]] | |||
Latest revision as of 15:26, 22 November 2010
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
- 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.