Profishark API 2.6.1.0
Loading...
Searching...
No Matches
ProfisharkAPIDiskDumpConfigEx Struct Reference

Direct capture configuration. More...

#include <ProfisharkAPI.h>

Data Fields

ProfisharkAPIState Loop
ProfisharkAPIState StopIfCacheFull
ProfisharkAPINetworkDataFormat FileFormat
uint64_t MaximumFileSize
uint64_t MaximumCacheSize
int FilesNumber
uint32_t MaximumFileDuration
ProfisharkAPIState FullFrame
wchar_t * CaptureDirectory
wchar_t * FilenamePattern

Detailed Description

Direct capture configuration.

Field Documentation

◆ CaptureDirectory

wchar_t* CaptureDirectory

Absolute path to the capture directory. Maximum string length : PROFISHARK_MAX_CAPTURE_DIRECTORY_LENGTH-1

◆ FileFormat

Capture file format. Not all formats are available for each device. Check in devices capabilities.

◆ FilenamePattern

wchar_t* FilenamePattern

File name pattern. Maximum string length : PROFISHARK_MAX_FILENAME_PATTERN_LENGTH-1 The following patterns are automatically replaced when the capture files are created:

  • N: a 5 characters sequence number (i.e 00000, 00001, ...) incremented for each file of the capture
  • Y: year number, 4 characters
  • y: year number, 2 characters
  • M: month number (1..12)
  • D: day number (1..31)
  • H: hour (0..23)
  • m: minute (0..59)
  • s: second (0..59)

The following constraints apply:

  • It must contain at least 'N'
  • It must not contain the following characters: ascii values <= 31, <, >, :, ", /, \, |, ?, *

◆ FilesNumber

int FilesNumber

Maximum number of files generated by the capture. 0 means no limit

◆ FullFrame

ProfisharkAPIState FullFrame

Enable full frame capture

◆ Loop

Enable round-robin style loop through files, erasing older files if needed.

◆ MaximumCacheSize

uint64_t MaximumCacheSize

Maximum cache size in bytes

◆ MaximumFileDuration

uint32_t MaximumFileDuration

Maximum duration of a capture file in seconds

◆ MaximumFileSize

uint64_t MaximumFileSize

Maximum size of a capture file in bytes. 0 means no limit

◆ StopIfCacheFull

ProfisharkAPIState StopIfCacheFull

Stop capture automatically when cache is full


The documentation for this struct was generated from the following file: