API Documentation

From IGAEditorWiki

This software provides an interface to the ad cache files, allowing you to develop third-party applications utilising the APIs, without needing to understand the file format or produce any interfaces to it.

This is for version: 0.1.5

Please note: The XML documentation used internally in C# and .NET is probably better kept than this. This page is intended to provide a quick reference, with some extended information.

1 IGACommon.dll
- 1.1 IGAConnector

[edit]

IGACommon.dll

IGACommon.dll provides the interface to the ad cache files, as well as a handler for adpack files. As of version 0.1.5 the AdPackSupport.dll file is no longer used, and has been merged with the main program and IGACommon.dll. The library contains no IGA code in it at all - it is an entire, from-scratch implementation.

Bear in mind, if you are distributing software, you will need to satisfy the terms of the GNU General Public License. One of the requirements is that you give a written offer for source code when distributing your software that links to this library.

[edit]

IGAConnector

This is the main interface to icontent.cache.

[edit]

Constructors

IGADatabaseConnector (String name)

Creates a new connection to the icontent.cache file located at the path specified in name.

[edit]

Properties

[edit]

appInfo

AppInfo appInfo

Returns an AppInfo object giving information about the program that created the cache file. If AppSupported is false, then this will be incorrect.

[edit]

AppSupported

bool AppSupported

Returns true if the appId set in the cache file is one that is supported.

[edit]

MinTimeStoredInSeconds

bool MinTimeStoredInSeconds

Returns true if the MinTime field is stored in seconds. Returns false if it is stored in milliseconds.

[edit]

AppId

int AppId

Returns the AppId of the program that created the cache file, or 0 if none has been set (ie: it is empty). If it is set to 0, you can set this property to temporarily over-ride it. If you wish to make the change permanent, you'll need to call the ChangeAppID method.

[edit]