IMSZipMgr Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class FPStaticInterface, Class MacroEntry

Description:

This class is available in release 4.0 and later only.

This class represents the interface to the MAXScript Zip Module 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.

#include <imszip.h>

Inheritance diagram for IMSZipMgr:

List of all members.

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

anonymous enum

Search for all occurrences

Enumerator:

fileInPackage	Search for all occurrences
unloadPackage	Search for all occurrences

         { fileInPackage,
           unloadPackage,
        }; 

---

Member Function Documentation

virtual BOOL FileInPackage	(	const MCHAR *	file_name,
		MSTR &	extract_dir
	)		[pure virtual]

Search for all occurrences

Remarks:

This method will unload and run a zip module and return the extract_dir.

Parameters:

MCHAR* file_name

The file name of the ZIP script module.

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]

Search for all occurrences

Remarks:

This method will unload the module 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 module and return the MacroEntry in dropScript.

Parameters:

MCHAR* file_name

The file name of the ZIP script module.

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.