IMSZipMgr Class Reference
 
 
 
IMSZipMgr Class Reference

#include <imszip.h>

Inheritance diagram for IMSZipMgr:
FPStaticInterface FPInterfaceDesc FPInterface BaseInterface InterfaceServer MaxHeapOperators

Class Description

See also:
Class FPStaticInterface, Class MacroEntry

Description:
This class represents the interface to the MAXScript Zip Package Manager. You can obtain a pointer to the Browser Manager interface using; IMSZipMgr* GetMSZipMgr(). This macro will return (IMSZipMgr*)GetCOREInterface(MSZIP_MGR_INTERFACE).

All methods of this class are Implemented by the System.

Public Types

enum   { fileInPackage, unloadPackage }

Public Member Functions

virtual BOOL  FileInPackage (const MCHAR *file_name, MSTR &extract_dir)=0
virtual BOOL  UnloadPackage (const MCHAR *file_name, MSTR &extract_dir, MSTR &dropFile, MacroEntry *&dropScript)=0

Member Enumeration Documentation


Member Function Documentation

virtual BOOL FileInPackage ( const MCHAR *  file_name,
MSTR extract_dir 
) [pure virtual]
Remarks:
This method will unload and run a zip package and return the extract_dir.
Parameters:
MCHAR* file_name

The file name of the ZIP script package.

MSTR& extract_dir

The directory in which the files were extracted.
Returns:
TRUE if successful, otherwise FALSE.
virtual BOOL UnloadPackage ( const MCHAR *  file_name,
MSTR extract_dir,
MSTR dropFile,
MacroEntry *&  dropScript 
) [pure virtual]
Remarks:
This method will unload the package while ignoring any drop or run commands and return the extract_dir and any primary drop file. If the primary dropFile is a *.ds, compile it in context of the package and return the MacroEntry in dropScript.
Parameters:
MCHAR* file_name

The file name of the ZIP script package.

MSTR& extract_dir

The directory in which the files were extracted.

MSTR& dropFile

The primary drop file.

MacroEntry*& dropScript

The resulting MacroEntry.
Returns:
TRUE if successful, otherwise FALSE.