File Options.h

↰ Parent directory (DiagLog)

Definition (DiagLog/Options.h)

Includes

Included By

Full File Listing

Typedefs

typedef void *Snpe_Options_Handle_t

A typedef to indicate a SNPE Options handle

Functions

Snpe_Options_Handle_t Snpe_Options_Create()
Snpe_ErrorCode_t Snpe_Options_Delete(Snpe_Options_Handle_t handle)

Destroys/frees a Options

Parameters

handle – [in] : Handle to access Options object

Returns

indication of success/failures

const char *Snpe_Options_GetDiagLogMask(Snpe_Options_Handle_t handle)

Gets DiagLogMask diagLogMask: Enables diag logging only on the specified area mask

Parameters

handle – [in] : Handle to access Options object

Returns

diagLogMask as a const char*

void Snpe_Options_SetDiagLogMask(Snpe_Options_Handle_t handle, const char *diagLogMask)

Sets DiagLogMask diagLogMask: Enables diag logging only on the specified area mask

Parameters

  • handle – [in] : Handle to access Options object

  • diagLogMask – [in] : specific area where logging needs to be enabed

const char *Snpe_Options_GetLogFileDirectory(Snpe_Options_Handle_t handle)

Gets logFileDirectory logFileDirectory: The path to the directory where log files will be written. The path may be relative or absolute. Relative paths are interpreted

Parameters

handle – [in] : Handle to access Options object

Returns

logFileDirectory as a const char*

void Snpe_Options_SetLogFileDirectory(Snpe_Options_Handle_t handle, const char *logFileDirectory)

Sets logFileDirectory logFileDirectory: The path to the directory where log files will be written. The path may be relative or absolute. Relative paths are interpreted

Parameters

  • handle – [in] : Handle to access Options object

  • logFileDirectory – [in] : path for saving the log files

const char *Snpe_Options_GetLogFileName(Snpe_Options_Handle_t handle)

Gets logFileName logFileName: The name used for log files. If this value is empty then BaseName will be used as the default file name.

Parameters

handle – [in] : Handle to access Options object

Returns

logFileName as a const char*

void Snpe_Options_SetLogFileName(Snpe_Options_Handle_t handle, const char *logFileName)

Sets logFileName logFileName: The name used for log files. If this value is empty then BaseName will be used as the default file name.

Parameters

  • handle – [in] : Handle to access Options object

  • logFileName – [in] : name of log file

uint32_t Snpe_Options_GetLogFileRotateCount(Snpe_Options_Handle_t handle)

Gets the maximum number of log files to create. If set to 0 no log rotation will be used and the log file name specified will be used each time, overwriting any existing log file that may exist.

Parameters

handle – [in] : Handle to access options object.

Returns

max log files to create

void Snpe_Options_SetLogFileRotateCount(Snpe_Options_Handle_t handle, uint32_t logFileRotateCount)

Sets the maximum number of log files to create. If set to 0 no log rotation will be used and the log file name specified will be used each time, overwriting any existing log file that may exist.

Parameters

  • handle – [in] : Handle to access options object.

  • logFileRotateCount – [in] : max log files to create

int Snpe_Options_GetLogFileReplace(Snpe_Options_Handle_t handle)

If the log file already exists, control whether it will be replaced

Parameters

handle – [in] : Handle to access options object

Returns

1 if log file will be replaced, 0 otherwise

void Snpe_Options_SetLogFileReplace(Snpe_Options_Handle_t handle, int logFileReplace)

If the log file already exists, control whether it will be replaced

Parameters

  • handle – [in] : Handle to access options object

  • logFileReplace – [in] : 1 if log file to be replaced, 0 otherwise