CompressProject(String,String,String) Method

In This Topic

Compresses a project.

Syntax

public void CompressProject( 
   string strFullLinkFileName,
   string strConfigScheme,
   string strFilterScheme
)

public:
void CompressProject( 
   String^ strFullLinkFileName,
   String^ strConfigScheme,
   String^ strFilterScheme
)

strFullLinkFileName: Full link file name of the project to be compressed.
strConfigScheme: Configuration scheme. If an empty string is passed to the parameter, the last\-used scheme will be reused which is currently set in GUI.
strFilterScheme: Filter scheme. If an empty string is passed to the parameter, the last\-used scheme will be re\-used which is currently set in GUI. When null is passed no filter scheme is used.

Exceptions

Exception	Description
ArgumentNullException	Thrown in case of missing arguments.
ArgumentException	Thrown in case if invalid arguments, e.g. an invalid project is set.
ApplicationException	\Internal interface for compressing could not be created.
Eplan.EplApi.Base.BaseException	An error occurred when compressing the project.

Remarks

The specified project may be open or not. If the project was not open, it will be opened for compressing and will be closed subsequently.