DownloadOpParam Class Reference

Download operation parameter structure - passes the minimum necessary information to the Op All operations derived from DownloadOp should be invoked with parameters derived from this class. More...

#include <inetop.h>

Inheritance diagram for DownloadOpParam:

OpParam CCObject SimpleCCObject AsynchBitmapImportParam BitmapDownloadParam GenericDownloadParam HelpDownloadParam WebFontInstallParam List of all members.

Public Member Functions

void * operator new (size_t stSize, LPCSTR lpszFileName, INT32 nLine)
 This functions adds an item into the memory tracking list and stores the filename and line number if it is passed in. Both versions of new call this function to handle all there DEBUG stuff.A version of the new operator that stores the filename etc into the memory tracking structure to help in debugging. This can be activated by including the following line :- MonoOn define new CAM_DEBUG_NEW MonoOff after all the IMPLEMENT_DYNAMIC() etc macros.
void * operator new (size_t stSize)
 This function allocates a block of memory to create a new SimpleCCObject derived thingy. This does not throw an exception, but returns NULL in the event of a failure. In debug builds it also keeps track of all allocations and will give a dump of all reamining blobs of memory when camelot exits.

Public Attributes

PathName file
String_256 strURL
BOOL bHasProgressDlg
String_256 strDescription
FileType type
AsynchDownload::Priority priority

Protected Member Functions

 DownloadOpParam ()

Static Protected Attributes

static void * pAllocatedMemory

Detailed Description

Download operation parameter structure - passes the minimum necessary information to the Op All operations derived from DownloadOp should be invoked with parameters derived from this class.

Author:
Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com>
Date:
3/03/97
NOTE: Objects of this type and any derived types MUST BE CREATED ON THE HEAP. Also, never delete objects of this type once you passed them to DownloadOp or a derived class

Definition at line 129 of file inetop.h.


Constructor & Destructor Documentation

DownloadOpParam::DownloadOpParam  )  [protected]
 

Definition at line 142 of file inetop.cpp.

00143 {
00144 #ifdef _DEBUG
00145     if ((void*) this != pAllocatedMemory)
00146         ERROR3("DownloadOpParam-derived objects should be allocated using the new operator");
00147     pAllocatedMemory = NULL;
00148 #endif
00149     // default to clipart download parameters
00150     type = TYPE_CLIPART;
00151     priority = AsynchDownload::PRIORITY_HIGH;
00152     bHasProgressDlg = TRUE;
00153     strDescription = _T("");
00154 }


Member Function Documentation

void* DownloadOpParam::operator new size_t  stSize  )  [inline]
 

This function allocates a block of memory to create a new SimpleCCObject derived thingy. This does not throw an exception, but returns NULL in the event of a failure. In debug builds it also keeps track of all allocations and will give a dump of all reamining blobs of memory when camelot exits.

Author:
Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>
Date:
15/7/93
Parameters:
size - The number of bytes to allocate [INPUTS]
Returns:
a pointer to the allocated memory (or NULL if the allocation failed)
See also:
SimpleCCObject::delete; SimpleCCObject::MemoryDump

Reimplemented from SimpleCCObject.

Definition at line 156 of file inetop.h.

00157     {
00158         return (pAllocatedMemory = SimpleCCObject::operator new(stSize));
00159     }

void* DownloadOpParam::operator new size_t  stSize,
LPCSTR  lpszFileName,
INT32  nLine
[inline]
 

This functions adds an item into the memory tracking list and stores the filename and line number if it is passed in. Both versions of new call this function to handle all there DEBUG stuff.A version of the new operator that stores the filename etc into the memory tracking structure to help in debugging. This can be activated by including the following line :- MonoOn define new CAM_DEBUG_NEW MonoOff after all the IMPLEMENT_DYNAMIC() etc macros.

Author:
Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>
Date:
23/7/93
Parameters:
size - Number of bytes required [INPUTS] FileName - The name of the file that caused the allocation Line - The line number in the file that caused the allocation
Returns:
a pointer to the allocated block of memory, or NULL if the allocation failed

Reimplemented from SimpleCCObject.

Definition at line 152 of file inetop.h.

00153     {
00154         return (pAllocatedMemory = SimpleCCObject::operator new(stSize, lpszFileName, nLine));
00155     }


Member Data Documentation

BOOL DownloadOpParam::bHasProgressDlg
 

Definition at line 138 of file inetop.h.

PathName DownloadOpParam::file
 

Definition at line 133 of file inetop.h.

void * DownloadOpParam::pAllocatedMemory [static, protected]
 

Definition at line 149 of file inetop.h.

AsynchDownload::Priority DownloadOpParam::priority
 

Definition at line 145 of file inetop.h.

String_256 DownloadOpParam::strDescription
 

Definition at line 141 of file inetop.h.

String_256 DownloadOpParam::strURL
 

Definition at line 135 of file inetop.h.

FileType DownloadOpParam::type
 

Definition at line 143 of file inetop.h.


The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:53:52 2007 for Camelot by  doxygen 1.4.4