VxSdk::VxLoginInfo Struct Reference

Represents the information needed to log in to a VideoXpert system. More...

#include <VxLoginInfo.h>

Public Member Functions
	VxLoginInfo ()
	Initializes a new instance of the VxLoginInfo struct. More...
	VxLoginInfo (const VxLoginInfo &ref)
	Initializes a new instance of the VxLoginInfo struct. More...
	~VxLoginInfo ()
	Finalizes an instance of the VxLoginInfo 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...
char	password [64]
	The password to login with. More...
char	username [64]
	The username to login with. More...
unsigned short	port
	The VideoXpert system port. More...

Detailed Description

Represents the information needed to log in to a VideoXpert system.

Definition at line 12 of file VxLoginInfo.h.

Constructor & Destructor Documentation

VxSdk::VxLoginInfo::VxLoginInfo ( )

inline

Initializes a new instance of the VxLoginInfo struct.

Definition at line 17 of file VxLoginInfo.h.

                      {
            Clear();
        }

VxSdk::VxLoginInfo::VxLoginInfo ( const VxLoginInfo &  ref )

inline

Initializes a new instance of the VxLoginInfo struct.

Parameters

ref	The reference.

Definition at line 25 of file VxLoginInfo.h.

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

VxSdk::VxLoginInfo::~VxLoginInfo ( )

inline

Finalizes an instance of the VxLoginInfo class.

Definition at line 37 of file VxLoginInfo.h.

                       {
            Clear();
        }

Member Function Documentation

void VxSdk::VxLoginInfo::Clear ( )

inline

Clears this instance.

Definition at line 44 of file VxLoginInfo.h.

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

Member Data Documentation

char VxSdk::VxLoginInfo::authToken[512]

The authentication token to use.

Definition at line 61 of file VxLoginInfo.h.

char VxSdk::VxLoginInfo::ipAddress[64]

The VideoXpert system IP.

Definition at line 65 of file VxLoginInfo.h.

char VxSdk::VxLoginInfo::password[64]

The password to login with.

Definition at line 69 of file VxLoginInfo.h.

unsigned short VxSdk::VxLoginInfo::port

The VideoXpert system port.

Definition at line 77 of file VxLoginInfo.h.

char VxSdk::VxLoginInfo::username[64]

The username to login with.

Definition at line 73 of file VxLoginInfo.h.

bool VxSdk::VxLoginInfo::useSsl

Indicates whether the connection will use SSL.

Definition at line 57 of file VxLoginInfo.h.

---

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

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