VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
VxSdk::VxAuthInfo Struct Reference

Represents the information needed to authenticate with a VideoXpert system. More...

#include <VxAuthInfo.h>

Public Member Functions

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

Public Attributes

bool useSsl
 Indicates whether the connection will use SSL. More...
 
char authToken [512]
 The authentication token to use. More...
 
char ipAddress [64]
 The VideoXpert system IP. More...
 
unsigned short port
 The VideoXpert system port. More...
 

Detailed Description

Represents the information needed to authenticate with a VideoXpert system.

Definition at line 12 of file VxAuthInfo.h.

Constructor & Destructor Documentation

VxSdk::VxAuthInfo::VxAuthInfo ( )
inline

Initializes a new instance of the VxAuthInfo struct.

Definition at line 17 of file VxAuthInfo.h.

17  {
18  Clear();
19  }
void Clear()
Clears this instance.
Definition: VxAuthInfo.h:42
VxSdk::VxAuthInfo::VxAuthInfo ( const VxAuthInfo ref)
inline

Initializes a new instance of the VxAuthInfo struct.

Parameters
refThe reference.

Definition at line 25 of file VxAuthInfo.h.

25  {
26  this->useSsl = ref.useSsl;
27  Utilities::StrCopySafe(this->authToken, ref.authToken);
28  Utilities::StrCopySafe(this->ipAddress, ref.ipAddress);
29  this->port = ref.port;
30  }
static void StrCopySafe(char(&dst)[dstSize], const char *src)
Performs a safe string copy.
Definition: VxUtilities.h:15
unsigned short port
The VideoXpert system port.
Definition: VxAuthInfo.h:65
bool useSsl
Indicates whether the connection will use SSL.
Definition: VxAuthInfo.h:53
char ipAddress[64]
The VideoXpert system IP.
Definition: VxAuthInfo.h:61
char authToken[512]
The authentication token to use.
Definition: VxAuthInfo.h:57
VxSdk::VxAuthInfo::~VxAuthInfo ( )
inline

Finalizes an instance of the VxAuthInfo class.

Definition at line 35 of file VxAuthInfo.h.

35  {
36  Clear();
37  }
void Clear()
Clears this instance.
Definition: VxAuthInfo.h:42

Member Function Documentation

void VxSdk::VxAuthInfo::Clear ( )
inline

Clears this instance.

Definition at line 42 of file VxAuthInfo.h.

42  {
43  this->useSsl = false;
44  VxZeroArray(this->authToken);
45  VxZeroArray(this->ipAddress);
46  this->port = 0;
47  }
#define VxZeroArray(src)
Definition: VxMacros.h:25
unsigned short port
The VideoXpert system port.
Definition: VxAuthInfo.h:65
bool useSsl
Indicates whether the connection will use SSL.
Definition: VxAuthInfo.h:53
char ipAddress[64]
The VideoXpert system IP.
Definition: VxAuthInfo.h:61
char authToken[512]
The authentication token to use.
Definition: VxAuthInfo.h:57

Member Data Documentation

char VxSdk::VxAuthInfo::authToken[512]

The authentication token to use.

Definition at line 57 of file VxAuthInfo.h.

char VxSdk::VxAuthInfo::ipAddress[64]

The VideoXpert system IP.

Definition at line 61 of file VxAuthInfo.h.

unsigned short VxSdk::VxAuthInfo::port

The VideoXpert system port.

Definition at line 65 of file VxAuthInfo.h.

bool VxSdk::VxAuthInfo::useSsl

Indicates whether the connection will use SSL.

Definition at line 53 of file VxAuthInfo.h.


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