VxSdk::VxNewExport Struct Reference

Represents a new export to be created. More...

#include <VxNewExport.h>

Public Member Functions
	VxNewExport ()
	Initializes a new instance of the VxNewExport struct. More...
	VxNewExport (const VxNewExport &ref)
	Initializes a new instance of the VxNewExport struct. More...
	~VxNewExport ()
	Finalizes an instance of the VxNewExport class. More...
void	Clear ()
	Clears this instance. More...

Public Attributes
char	name [64]
	The friendly name of the export. More...
char	password [64]
	The password for the export. If set, the export data will be signed and encrypted. This password will be required to decrypt the export data. If not set, the export data will not be signed or encrypted. More...
int	clipSize
	The size of clips. More...
VxExportFormat::Value	format
	The export format to use. More...
VxNewExportClip *	clips
	The clips that shall be included in this export when triggered. More...

Detailed Description

Represents a new export to be created.

Definition at line 13 of file VxNewExport.h.

Constructor & Destructor Documentation

VxSdk::VxNewExport::VxNewExport ( )

inline

Initializes a new instance of the VxNewExport struct.

Definition at line 18 of file VxNewExport.h.

                      {
            Clear();
        }

VxSdk::VxNewExport::VxNewExport ( const VxNewExport &  ref )

inline

Initializes a new instance of the VxNewExport struct.

Parameters

ref	The reference.

Definition at line 26 of file VxNewExport.h.

                                            {
            Utilities::StrCopySafe(this->name, ref.name);
            Utilities::StrCopySafe(this->password, ref.password);
            this->clipSize = ref.clipSize;
            this->format = ref.format;
            this->clips = ref.clips;
        }

VxSdk::VxNewExport::~VxNewExport ( )

inline

Finalizes an instance of the VxNewExport class.

Definition at line 37 of file VxNewExport.h.

                       {
            Clear();
        }

Member Function Documentation

void VxSdk::VxNewExport::Clear ( )

inline

Clears this instance.

Definition at line 44 of file VxNewExport.h.

                     {
            VxZeroArray(this->name);
            VxZeroArray(this->password);
            this->clipSize = 0;
            this->format = VxExportFormat::kUnknown;
            this->clips = nullptr;
        }

Member Data Documentation

VxNewExportClip* VxSdk::VxNewExport::clips

The clips that shall be included in this export when triggered.

Definition at line 73 of file VxNewExport.h.

int VxSdk::VxNewExport::clipSize

The size of clips.

Definition at line 65 of file VxNewExport.h.

VxExportFormat::Value VxSdk::VxNewExport::format

The export format to use.

Definition at line 69 of file VxNewExport.h.

char VxSdk::VxNewExport::name[64]

The friendly name of the export.

Definition at line 56 of file VxNewExport.h.

char VxSdk::VxNewExport::password[64]

The password for the export. If set, the export data will be signed and encrypted. This password will be required to decrypt the export data. If not set, the export data will not be signed or encrypted.

Definition at line 61 of file VxNewExport.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/VxNewExport.h