DescAPI.txt

(2 KB) Pobierz
WhereIsIt? version 3.50
Copyright (c) 1997,2003 Robert Galle
All Rights Reserved


Description API 2.20
====================

Welcome to the WhereIsIt's Description Application Programming Interface 
(Description API, or DescAPI), a special feature available to programmers 
to extend WhereIsIt's capabilities with automatic description importing. 
For all those new to programming, API is a standardized set of functions 
and procedures that allow both master program and extension library to 
communicate. With Description API, your end result will be a DLL library 
implementing functions described here, therefor allowing itself to 
integrate in WhereIsIt application.

DescAPI 2.0 is an enhanced version of the original DescAPI 1.0 and is used
in WhereIsIt 3.0 or newer. Unless your plugin is expected to work in older
WhereIsIt 2.xx as well, plugins should be complying with newer DescAPI 2.0.
WhereIsIt 3.xx can run and use all plugins, designed for DescAPI 1.0 or
DescAPI 2.0.

DescAPI 2.10 is extended version of DescAPI 2.0, introduced in WhereIsIt 
3.20. It adds support for file name formatting and custom icons plugins,
other parts are the same as in DescAPI 2.0. Plugins complying with DescAPI 
2.10 will work in all WhereIsIt 3.xx and newer versions, however new plugin
types will not be available in WhereIsIt versions prior to 3.20.

The main addition of DescAPI 2.20 in WhereIsIt 3.50 was added support for
new plugins type, runtime plugins.


You can find a detailed information on Description API in the enclosed help 
file.


A word of causion to C/C++ programmers using these files:
---------------------------------------------------------
Since I am using Delphi to develop WhereIsIt and my C/C++ knowledge is a bit
rusty by now, the enclosed C/C++ include files as well as references in the
help file may not be exact - I have just translated pascal syntax to C/C++.
If you find any errors in there, please let me know.

Files:
------
DescAPI.chm    The main Description API Programmer's Reference help file,
               containing full DescAPI specification and everything you need
               to know to write your own plugins.
DescAPI.inc    Delphi (pascal) include file with Description API definitions
DescAPI.h      C/C++ include file with Description API 2.10 definitions. 
               Function reference and syntax can be found in the help file.
DescAPI.txt    This file.


Robert Galle
April 2003
Zgłoś jeśli naruszono regulamin