plugins.wcx
Class OpenArchiveData

java.lang.Object
  plugins.wcx.OpenArchiveData

public class OpenArchiveData
extends java.lang.Object

OpenArchiveData is used in openArchive.

Author:

Ken

Field Summary

static int	PK_OM_EXTRACT Open file for processing (extract or test).
static int	PK_OM_LIST Open file for reading of file names only.

Constructor Summary

OpenArchiveData(java.lang.String arcName, int openmode, int openresult)
OpenArchiveData is used in OpenArchive.

Method Summary

java.lang.String	getArcName() Contains the name of the archive to open.
java.lang.String	getCmtBuf() The cmtBuf variable is for the file comment.
int	getCmtBufSize() The cmtBufSize variable is for the file comment.
int	getCmtSize() The cmtSize variable is for the file comment.
int	getCmtState() The cmtState variable is for the file comment.
int	getOpenMode() OpenMode is set to one of the following values: PK_OM_LIST - Open file for reading of file names only.
int	getOpenResult() Used to return one of the error values if an error occurs.

Methods inherited from class java.lang.Object

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

Field Detail

PK_OM_LIST

public static final int PK_OM_LIST

Open file for reading of file names only.

See Also:

Constant Field Values

PK_OM_EXTRACT

public static final int PK_OM_EXTRACT

Open file for processing (extract or test).

See Also:

Constant Field Values

Constructor Detail

OpenArchiveData

public OpenArchiveData(java.lang.String arcName,
                       int openmode,
                       int openresult)

OpenArchiveData is used in OpenArchive.

Parameters:

arcName - Contains the name of the archive to open.

openmode - Open mode

openresult - Used to return one of the error values if an error occurs.

Method Detail

getArcName

public final java.lang.String getArcName()

Contains the name of the archive to open.

Returns:

Returns the arcName.

getOpenMode

public final int getOpenMode()

OpenMode is set to one of the following values:

• PK_OM_LIST - Open file for reading of file names only.
• PK_OM_EXTRACT - Open file for processing (extract or test).

Note:

If the file is opened with OpenMode==PK_OM_LIST, ProcessFile will never be called by Total Commander.

Returns:

Returns the openMode.

getOpenResult

public final int getOpenResult()

Used to return one of the error values if an error occurs.

Returns:

Returns the openResult.

getCmtBuf

public final java.lang.String getCmtBuf()

The cmtBuf variable is for the file comment. It is currently not used by Total Commander, so may be set to NULL.

Returns:

Returns the cmtBuf.

getCmtBufSize

public final int getCmtBufSize()

The cmtBufSize variable is for the file comment. It is currently not used by Total Commander, so may be set to NULL.

Returns:

Returns the cmtBufSize.

getCmtSize

public final int getCmtSize()

The cmtSize variable is for the file comment. It is currently not used by Total Commander, so may be set to NULL.

Returns:

Returns the cmtSize.

getCmtState

public final int getCmtState()

The cmtState variable is for the file comment. It is currently not used by Total Commander, so may be set to NULL.

Returns:

Returns the cmtState.