VxSdk::VxNewUser Struct Reference

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

#include <VxNewUser.h>

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

Public Attributes
bool	mustChangePassword
	If true, the new user will be forced to change their password the first time they log in. More...
char	domain [64]
	The network domain for the user. Defaults to LOCAL. More...
char	employeeId [64]
	The employee identifier associated with the user. More...
char	firstName [64]
	The first name of user. More...
char	lastName [64]
	The last name of user. More...
char	name [64]
	The unique name of the user that this resource is representing. More...
char	note [1024]
	Supplemental information about the user. More...
char	password [64]
	The password to associate with the user. Must contain more than 7 characters. More...
int	phoneNumberSize
	The size of phoneNumbers. More...
VxPhoneNumber *	phoneNumbers
	The telephone number(s) for the user. More...

Detailed Description

Represents a new user to be created.

Definition at line 12 of file VxNewUser.h.

Constructor & Destructor Documentation

VxSdk::VxNewUser::VxNewUser ( )

inline

Initializes a new instance of the VxNewUser struct.

Definition at line 17 of file VxNewUser.h.

                    {
            Clear();
        }

VxSdk::VxNewUser::VxNewUser ( const VxNewUser &  ref )

inline

Initializes a new instance of the VxNewUser struct.

Parameters

ref	The reference.

Definition at line 25 of file VxNewUser.h.

                                        {
            this->mustChangePassword = ref.mustChangePassword;
            Utilities::StrCopySafe(this->domain, ref.domain);
            Utilities::StrCopySafe(this->employeeId, ref.employeeId);
            Utilities::StrCopySafe(this->firstName, ref.firstName);
            Utilities::StrCopySafe(this->lastName, ref.lastName);
            Utilities::StrCopySafe(this->name, ref.name);
            Utilities::StrCopySafe(this->note, ref.note);
            Utilities::StrCopySafe(this->password, ref.password);
            this->phoneNumberSize = ref.phoneNumberSize;
            this->phoneNumbers = ref.phoneNumbers;
        }

VxSdk::VxNewUser::~VxNewUser ( )

inline

Finalizes an instance of the VxNewUser struct.

Definition at line 41 of file VxNewUser.h.

                     {
            Clear();
        }

Member Function Documentation

void VxSdk::VxNewUser::Clear ( )

inline

Clears this instance.

Definition at line 48 of file VxNewUser.h.

                     {
            this->mustChangePassword = false;
            VxZeroArray(this->domain);
            VxZeroArray(this->employeeId);
            VxZeroArray(this->firstName);
            VxZeroArray(this->lastName);
            VxZeroArray(this->name);
            VxZeroArray(this->note);
            VxZeroArray(this->password);
            this->phoneNumberSize = 0;
            this->phoneNumbers = nullptr;
        }

Member Data Documentation

char VxSdk::VxNewUser::domain[64]

The network domain for the user. Defaults to LOCAL.

Definition at line 69 of file VxNewUser.h.

char VxSdk::VxNewUser::employeeId[64]

The employee identifier associated with the user.

Definition at line 73 of file VxNewUser.h.

char VxSdk::VxNewUser::firstName[64]

The first name of user.

Definition at line 77 of file VxNewUser.h.

char VxSdk::VxNewUser::lastName[64]

The last name of user.

Definition at line 81 of file VxNewUser.h.

bool VxSdk::VxNewUser::mustChangePassword

If true, the new user will be forced to change their password the first time they log in.

Definition at line 65 of file VxNewUser.h.

char VxSdk::VxNewUser::name[64]

The unique name of the user that this resource is representing.

Definition at line 85 of file VxNewUser.h.

char VxSdk::VxNewUser::note[1024]

Supplemental information about the user.

Definition at line 89 of file VxNewUser.h.

char VxSdk::VxNewUser::password[64]

The password to associate with the user. Must contain more than 7 characters.

Definition at line 93 of file VxNewUser.h.

VxPhoneNumber* VxSdk::VxNewUser::phoneNumbers

The telephone number(s) for the user.

Definition at line 101 of file VxNewUser.h.

int VxSdk::VxNewUser::phoneNumberSize

The size of phoneNumbers.

Definition at line 97 of file VxNewUser.h.

---

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

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