CJobText Class Reference

The CJobText class stores job information which is of a dynamic nature or of variable length. More...

#include <maxnet_job.h>

Inheritance diagram for CJobText:

Public Member Functions
	CJobText ()
	~CJobText ()
int	Count ()
int	Add (JobText *jt)
void	Delete (int idx, int count=1)
void	Reset ()
JobText *	Buffer ()
int	BufferSize ()
JobText &	operator[] (const int i)
int	FindJobText (JOB_TEXT_TYPE tp, int start=0)
bool	GetTextItem (MCHAR *text, size_t textSize, JOB_TEXT_TYPE type, int start=0, int *idx=nullptr)
bool	GetUser (MCHAR *user, size_t userSize)
bool	GetComputer (MCHAR *computer, size_t computerSize)
bool	GetFrames (MCHAR *frames, size_t framesSize)
bool	GetShare (MCHAR *share, size_t shareSize)

Protected Attributes
void *	list

Friends
class	MaxNetManagerImp

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Detailed Description

The CJobText class stores job information which is of a dynamic nature or of variable length.

See also

MaxNetCallBack, JobText, JOB_TEXT_TYPE

Constructor & Destructor Documentation

CJobText()

CJobText

(

)

~CJobText()

~CJobText

(

)

Remarks

Destructor. The CJobText buffers will be deallocated.

Member Function Documentation

Count()

int Count

(

)

Remarks

This method return the number of JobText buffers in the list. Note: Developers should use Job.jobtextcount to find out how many elements there are.

Add()

int Add

(

JobText *

jt

)

Remarks

This method will add another JobText buffer.

Parameters

[in]

jt

A pointer to the JobText buffer to add.

Returns

The number of JobText buffers.

Delete()

void Delete	(	int	idx,
		int	count = 1
	)

Remarks

This method will delete one or a sequence of buffers.

Parameters

[in]	idx	The position of the first index to be deleted.
[in]	count	The number of entries to delete.

Reset()

void Reset

(

)

Remarks

This method will reset and deallocate the CJobText buffers.

Buffer()

JobText* Buffer

(

)

Remarks

This method will return a pointer to the actual JobText buffer.

BufferSize()

int BufferSize

(

)

Remarks

This method returns the total size of the JobText buffer.

operator[]()

JobText& operator[]

(

const int

i

)

Remarks

This access operator returns a reference to a JobText entry.

Parameters

[in]

i

The index of the JobText buffer to return.

FindJobText()

int FindJobText	(	JOB_TEXT_TYPE	tp,
		int	start = 0
	)

Remarks

This method allows you to search for a JobText entry by its type. Refer to the list of Job Text types for details.

Parameters

[in]	tp	The Job Text type you wish to find.
[in]	start	The start position from which to initiate the search process.

Returns

The index of the entry which was found, or -1 if not found.

GetTextItem()

bool GetTextItem	(	MCHAR *	text,
		size_t	textSize,
		JOB_TEXT_TYPE	type,
		int	start = 0,
		int *	idx = nullptr
	)

Remarks

This method retrieves an index based on it's Text Type. Refer to JOB_TEXT_TYPE for details.

Parameters

[out]	text	A pointer to the text buffer which will be filled in by the method.
[in]	textSize	The size in characters of the text buffer which will be filled in by the method. If the text buffer is not big enough to hold the output (including a null terminator), the result is truncated.
[in]	type	The Job Text type you wish to find.
[in]	start	The start position from which to retrieve the text item.
[in]	idx	A pointer to the index found.

Returns

TRUE if the method was successful, otherwise FALSE.

GetUser()

bool GetUser	(	MCHAR *	user,
		size_t	userSize
	)

Remarks

This method will retrieve the user name associated with a job.

Parameters

[out]	user	The user name which was retrieved.
[in]	userSize	The size in characters of the user buffer which will be filled in by the method. If the user buffer is not big enough to hold the output (including a null terminator), the result is truncated.

Returns

TRUE if the user name was retrieved, otherwise FALSE.

GetComputer()

bool GetComputer	(	MCHAR *	computer,
		size_t	computerSize
	)

Remarks

This method will retrieve the computer name associated with a job.

Parameters

[out]	computer	The computer name which was retrieved.
[in]	computerSize	The size in characters of the computer buffer which will be filled in by the method. If the computer buffer is not big enough to hold the output (including a null terminator), the result is truncated.

Returns

TRUE if the computer name was retrieved, otherwise FALSE.

GetFrames()

bool GetFrames	(	MCHAR *	frames,
		size_t	framesSize
	)

Remarks

This method will retrieve the frame sequence (such as the "1,2,4,5-40" types).

Parameters

[out]	frames	The frames retrieved.
[in]	framesSize	The size in characters of the frames buffer which will be filled in by the method. If the frames buffer is not big enough to hold the output (including a null terminator), the result is truncated.

Returns

TRUE if the frame sequence string was retrieved, otherwise FALSE.

GetShare()

bool GetShare	(	MCHAR *	share,
		size_t	shareSize
	)

Remarks

This method will retrieve the Manager's network share associated with a job.

Parameters

[out]	share	The network share which was retrieved.
[in]	shareSize	The size in characters of the share buffer which will be filled in by the method. If the share buffer is not big enough to hold the output (including a null terminator), the result is truncated.

Returns

TRUE if the network share was retrieved, otherwise FALSE.

Friends And Related Function Documentation

MaxNetManagerImp

friend class MaxNetManagerImp

friend

Member Data Documentation

list

void* list

protected