Detailed Description
- See also:
- MaxNetCallBack, JobText, List of Job Text
Types
- Description:
- This class is available in release 4.0 and later only.
The CJobText class stores job information which is of a dynamic nature or of variable length.
#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, JOB_TEXT_TYPE type, int start=0, int *idx=0) |
| bool | GetUser (MCHAR *user) |
| bool | GetComputer (MCHAR *computer) |
| bool | GetFrames (MCHAR *frames) |
| bool | GetShare (MCHAR *share) |
Protected Attributes |
|
| void * | list |
Friends |
|
| class | MaxNetManagerImp |
Constructor & Destructor Documentation
| CJobText | ( | ) |
Member Function Documentation
| 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.
| int Add | ( | JobText * | jt | ) |
| void Delete | ( | int | idx, |
| int | count = 1 |
||
| ) |
- Remarks:
- This method will delete one or a sequence of buffers.
- Parameters:
- int idx
The position of the first index to be deleted.
int count
The number of entries to delete.
| void Reset | ( | ) |
- Remarks:
- This method will reset and deallocate the CJobText buffers.
| int BufferSize | ( | ) |
- Remarks:
- This method returns the total size of the JobText buffer.
| JobText& operator[] | ( | const int | i | ) |
| 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:
- JOB_TEXT_TYPE tp
The Job Text type you wish to find.
int 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.
| bool GetTextItem | ( | MCHAR * | text, |
| JOB_TEXT_TYPE | type, | ||
| int | start = 0, |
||
| int * | idx = 0 |
||
| ) |
- Remarks:
- This method retrieves an index based on it's Text Type. Refer to the List of Job Text Types for details.
- Parameters:
- MCHAR* text
A pointer to the text buffer which will be filled in by the method.
JOB_TEXT_TYPE type
The Job Text type you wish to find.
int start
The start position from which to retrieve the text item.
int* idx
A pointer to the index found.
- Returns:
- TRUE if the method was successful, otherwise FALSE.
| bool GetUser | ( | MCHAR * | user | ) |
- Remarks:
- This method will retrieve the user name associated with a job.
- Parameters:
- MCHAR* user
The user name which was retrieved.
- Returns:
- TRUE if the user name was retrieved, otherwise FALSE.
| bool GetComputer | ( | MCHAR * | computer | ) |
- Remarks:
- This method will retrieve the computer name associated with a job.
- Parameters:
- MCHAR* computer
The computer name which was retrieved.
- Returns:
- TRUE if the computer name was retrieved, otherwise FALSE.
| bool GetFrames | ( | MCHAR * | frames | ) |
- Remarks:
- This method will retrieve the frame sequence (such as the "1,2,4,5-40" types).
- Parameters:
- MCHAR *frames
The frames retrieved.
- Returns:
- TRUE if the frame sequence string was retrieved, otherwise FALSE.
| bool GetShare | ( | MCHAR * | share | ) |
- Remarks:
- This method will retrieve the Manager's network share associated with a job.
- Parameters:
- MCHAR* share
The network share which was retrieved.
- Returns:
- TRUE if the network share was retrieved, otherwise FALSE.
- Operators:
Friends And Related Function Documentation
friend class MaxNetManagerImp
[friend] |
Member Data Documentation
void* list
[protected] |
