WinCvtGetImportConverterList

The WinCvtGetImportConverterList function retrieves the list of converters that can convert from native format to RTF.

WINCVT_STATUS
WinCvtGetImportConverterList(
  WINCVT_CVT_LIST* List,    // The resulting list of converters.
  LPCSTR szClass,           // The class to look for (optional.)
  LPCSTR szExtension,       // The extension to look for (optional.)
  LPCSTR szFilenameToVerify // The file name to confirm against (optional.)
);

Parameters

List
Pointer to a list object. Upon successful completion of this function, this will point to a list of import conversion classes the system supports that match the specified extension and class criteria. To enumerate this list, use the WinCvtGetFirstClass and WinCvtGetNextClass functions. To free this list, call WinCvtFreeConverterList.
szClass
Specifies the class to locate. If specified, the list will contain only items with that class name. If NULL, all classes of converters will be returned.
szExtension
Specifies the extension to look for. If specified, only classes that support importing from the specified extension will be returned. This parameter can also include a full filename whose extension should be used in the search. If NULL, converters will be returned regardless of the extensions they support.
szFilenameToVerify
Specifies the filename to verify against. If specified, each converter matching the szClass and szExtension criteria will be interrogated to determine if it can import the specified file. If NULL, converters will be returned regardless of capabilities over a particular file.

Return Values

If the function succeeds, the return value is WINCVT_SUCCESS. If the function fails, the return value is the error code describing the failure. This code can be turned into a human readable string using the WinCvtGetErrorString.

Remarks

The WinCvtGetImportConverterList function retrieves the list of converters that can convert from native format to RTF. This list can be filtered by class, extension and ability to convert a specific file. If both szClass, szExtension and szFilenameToVerify are NULL, all import converters supported by the system will be returned. To install a new converter so that it will be returned by this function, use the WinCvtInstallConverter function. To list converters that support exporting (converting from RTF to a particular format), use the WinCvtGetExportConverterList function.

QuickInfo

WinCvt: Requires 0.1.0.
Header: Declared in WinCvt.h.
Import Library: Use WinCvt.lib.

See Also

WinCvtFreeConverterList, WinCvtGetFirstClass, WinCvtGetNextClass, WinCvtGetErrorString, WinCvtGetExportConverterList, WinCvtInstallConverter.