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.

                     {
            Clear();
        }

VxSdk::VxAuthInfo::VxAuthInfo ( const VxAuthInfo &  ref )

inline

Initializes a new instance of the VxAuthInfo struct.

Parameters

ref	The reference.

Definition at line 25 of file VxAuthInfo.h.

                                          {
            this->useSsl = ref.useSsl;
            Utilities::StrCopySafe(this->authToken, ref.authToken);
            Utilities::StrCopySafe(this->ipAddress, ref.ipAddress);
            this->port = ref.port;
        }

VxSdk::VxAuthInfo::~VxAuthInfo ( )

inline

Finalizes an instance of the VxAuthInfo class.

Definition at line 35 of file VxAuthInfo.h.

                      {
            Clear();
        }

Member Function Documentation

void VxSdk::VxAuthInfo::Clear ( )

inline

Clears this instance.

Definition at line 42 of file VxAuthInfo.h.

                     {
            this->useSsl = false;
            VxZeroArray(this->authToken);
            VxZeroArray(this->ipAddress);
            this->port = 0;
        }

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:

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