plugins
Class DefaultParam

java.lang.Object
  plugins.DefaultParam

public class DefaultParam
extends java.lang.Object

DefaultParamStruct is passed to inform the plugin about the current plugin interface version and ini file location.

Author:

Ken

Constructor Summary

DefaultParam(int size, long pluginInterfaceVersionLow, long pluginInterfaceVersionHi, java.lang.String defaultIniName)
DefaultParam is passed to inform the plugin about the current plugin interface version and ini file location.

Method Summary

java.lang.String	getDefaultIniName() This is a fully qualified path+file name, and will be in the same directory as the wincmd.ini.
long	getPluginInterfaceVersionHi() High value of plugin interface version.
long	getPluginInterfaceVersionLow() Low value of plugin interface version.
int	getSize() The size of the structure, in bytes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultParam

public DefaultParam(int size,
                    long pluginInterfaceVersionLow,
                    long pluginInterfaceVersionHi,
                    java.lang.String defaultIniName)

DefaultParam is passed to inform the plugin about the current plugin interface version and ini file location.

Parameters:

size - The size of the structure, in bytes. Later revisions of the plugin interface may add more structure members, and will adjust this size field accordingly.

pluginInterfaceVersionLow - Low value of plugin interface version. This is the value after the comma, multiplied by 100! Example. For plugin interface version 1.3, the low DWORD is 30 and the high DWORD is 1.

pluginInterfaceVersionHi - High value of plugin interface version.

defaultIniName - Suggested location+name of the ini file where the plugin could store its data. This is a fully qualified path+file name, and will be in the same directory as the wincmd.ini. It's recommended to store the plugin data in this file or at least in this directory, because the plugin directory or the Windows directory may not be writable!

Method Detail

getDefaultIniName

public final java.lang.String getDefaultIniName()

This is a fully qualified path+file name, and will be in the same directory as the wincmd.ini. It's recommended to store the plugin data in this file or at least in this directory, because the plugin directory or the Windows directory may not be writable!

Returns:

Suggested location+name of the ini file where the plugin could store its data

getPluginInterfaceVersionHi

public final long getPluginInterfaceVersionHi()

High value of plugin interface version. This is the value after the comma, multiplied by 100! Example. For plugin interface version 1.3, the low DWORD is 30 and the high DWORD is 1.

Returns:

High value of plugin interface version

getPluginInterfaceVersionLow

public final long getPluginInterfaceVersionLow()

Low value of plugin interface version. This is the value after the comma, multiplied by 100! Example. For plugin interface version 1.3, the low DWORD is 30 and the high DWORD is 1.

Returns:

Low value of plugin interface version

getSize

public final int getSize()

The size of the structure, in bytes. Later revisions of the plugin interface may add more structure members, and will adjust this size field accordingly.

Returns:

The size of the structure