HM_ExtAPI::SetScratchFolder()

Turns on or off generation of log files by different components used within HyperMesh, and sets the folder to redirect output of these files.

Syntax

bool SetScratchFolder(
bool  enable_output,
const char*  folder_name
);

Type

HyperMesh Ext API Function

Description

When HyperMesh module is loaded the default behavior is to disable the output of log files generated by HyperMesh and its components.

If the function succeeds, the return value is true. If the function fails, the return value is false. To get extended value information, call HM_ExtAPI::GetLastErrorCode().

Requires including hm_extapi.h.

Inputs

enable_output: [in] - Specifies output of log files should be enabled or disabled. The parameter can have one of following values.; true - Enable file output.; false - disable file output.
folder_name: [in] - Specifies the name of the folder to write log files generated by HyperMesh. This parameter is ignored if the value of enable_output is false. Setting the value of the parameter folder_name to NULL will result in redirecting log files into current folder of the process.

Errors

None.