Collapse all Symbian^3 Application Developer Library

RDirectPrintClient Class Reference

class RDirectPrintClient : public RSessionBase

Inherits from

RDirectPrintClient
- RSessionBase
  - RHandleBase

Public Member Functions
	RDirectPrintClient ()
IMPORT_C TInt	CancelCreateJob ()
IMPORT_C TInt	CancelDiscovery ()
IMPORT_C TInt	CancelPrintJob ()
IMPORT_C TInt	CancelStartDiscovery ()
IMPORT_C void	Close ()
IMPORT_C void	ConnectL ()
IMPORT_C TInt	ContinueCreateJob ( TDirectPrintJobGuardData &, TRequestStatus &)
IMPORT_C TInt	ContinuePrintJob ()
IMPORT_C TInt	CountConnections ( TInt &)
IMPORT_C TInt	CreateJob ( TInt , TDirectPrintJobGuardData &, RPointerArray < TDesC > &, TRequestStatus &)
IMPORT_C TInt	GetJobSetting ( TInt , TInt &)
IMPORT_C TInt	GetJobStatus ()
IMPORT_C TInt	GetJobTemplateIcon ( TInt , TInt &)
IMPORT_C TInt	GetNumPreviewPages ()
IMPORT_C TInt	GetNumPrintPages ()
IMPORT_C TInt	GetPrinterCapability ( TInt , TInt , TDirectPrintCapability &)
IMPORT_C TInt	GetPrinterCapabilityIDs ( TInt , RArray < TInt > &)
IMPORT_C TInt	GetPrinterStatus ( TInt )
IMPORT_C TInt	GetProtocolNames ( RSelectItemArray &)
IMPORT_C TInt	IsPictBridgeMode ()
IMPORT_C TInt	ReleaseEngine ()
IMPORT_C TInt	RemoveCachedPrinter ( TInt )
IMPORT_C TInt	ReserveEngine ()
IMPORT_C TInt	SetForeground ( TInt )
IMPORT_C TInt	SetJobSetting ( TInt , TInt , TInt &)
IMPORT_C TInt	SetNumberOfCopies (const RArray < TInt > &)
IMPORT_C TInt	SubmitPrintJob ()
IMPORT_C TInt	SupportedProtocols ()
TVersion	Version ()

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Private Attributes
TDirectPrintCapability *	iCapability
TPtr8	iDicsoveryDataPtr
TPtr8	iIdleDataPtr
TPtr8	iJobDataPtr
TPtr8	iNameDataPtr

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RDirectPrintClient()

IMPORT_C

RDirectPrintClient

(

)

Constructor

Member Functions Documentation

CancelCreateJob()

IMPORT_C TInt

CancelCreateJob

(

)

const

Cancel creating print job

CancelDiscovery()

IMPORT_C TInt

CancelDiscovery

(

)

const

Cancel discovery

CancelPrintJob()

IMPORT_C TInt

CancelPrintJob

(

)

const

Cancels the print job. This is an asynchronous command. MPrintEventObserver::PrintJobProgressEvent will be called with the status of TPrintJobProgressEventStatus::EDone when the cancellation is completed. The notification can potentially be received by the client before this command returns to the client.

CancelStartDiscovery()

IMPORT_C TInt

CancelStartDiscovery

(

)

const

Cancel starting discovery

Close()

IMPORT_C void

(

)

Close the session

ConnectL()

IMPORT_C void

ConnectL

(

)

Connect to the DirectPrint server

ContinueCreateJob(TDirectPrintJobGuardData &, TRequestStatus &)

IMPORT_C TInt	ContinueCreateJob	(	TDirectPrintJobGuardData &	aData,
			TRequestStatus &	aStatus
		)

Set next request for print job event. Asynchronous function.

Parameters

TDirectPrintJobGuardData & aData	place holder for print job event. On function completion contains print job event data.
TRequestStatus & aStatus	request status

ContinuePrintJob()

IMPORT_C TInt

ContinuePrintJob

(

)

const

Continues printing and / or submitting a print job.

CountConnections(TInt &)

IMPORT_C TInt

CountConnections

(

TInt &

aConnections

)

const

Count connections to the server ( all clients in all prosesses )

Parameters

TInt & aConnections

holder for connnections count

CreateJob(TInt, TDirectPrintJobGuardData &, RPointerArray< TDesC > &, TRequestStatus &)

IMPORT_C TInt	CreateJob	(	TInt	aPrinterID,
			TDirectPrintJobGuardData &	aData,
			RPointerArray < TDesC > &	aImages,
			TRequestStatus &	aStatus
		)

Registers the IdleObserver to send idle event notifications. Asynchronous function.

Parameters

TInt aPrinterID	printer id
TDirectPrintJobGuardData & aData	place holder for print job event. On function completion contains print job event data.
RPointerArray < TDesC > & aImages	array of image file names
TRequestStatus & aStatus	request status

GetJobSetting(TInt, TInt &)

IMPORT_C TInt	GetJobSetting	(	TInt	aCapabilityID,
			TInt &	aValue
		)	const

Gets a setting configured for the created print job.

Parameters

TInt aCapabilityID	ID of the capability of interest.
TInt & aValue	Capability value.

GetJobStatus()

IMPORT_C TInt

GetJobStatus

(

)

const

Gets the status of the printing job created

GetJobTemplateIcon(TInt, TInt &)

IMPORT_C TInt	GetJobTemplateIcon	(	TInt	aTemplateID,
			TInt &	aFbsBitmapHandle
		)	const

Gets the icon representing a given layout or template.

Parameters

TInt aTemplateID	ID of the template / layout of interest.
TInt & aFbsBitmapHandle	Handle to the appropriate bitmap.

GetNumPreviewPages()

IMPORT_C TInt

GetNumPreviewPages

(

)

const

Gets the number of pages in the preview.

GetNumPrintPages()

IMPORT_C TInt

GetNumPrintPages

(

)

const

Gets the number of pages to be printed

GetPrinterCapability(TInt, TInt, TDirectPrintCapability &)

IMPORT_C TInt	GetPrinterCapability	(	TInt	aPrinterID,
			TInt	aCapabilityID,
			TDirectPrintCapability &	aCapability
		)	const

Gets the detail of a certain capability of a certain printer.

Parameters

TInt aPrinterID	The exposed ID of the printer the client wants to know about.
TInt aCapabilityID	ID of the capability of interest.
TDirectPrintCapability & aCapability	Capability information.

GetPrinterCapabilityIDs(TInt, RArray< TInt > &)

IMPORT_C TInt	GetPrinterCapabilityIDs	(	TInt	aPrinterID,
			RArray < TInt > &	aCapabilityIDs
		)	const

Gets the IDs of the capabilities supported by the printer specified.

Parameters

TInt aPrinterID	The exposed ID of the printer the client wants to know about.
RArray < TInt > & aCapabilityIDs	Array containing the ID's of the capabilities of the specified printer.

GetPrinterStatus(TInt)

IMPORT_C TInt

GetPrinterStatus

(

TInt

aPrinterID

)

const

Gets the status of the printer

Parameters

TInt aPrinterID

The exposed ID of the printer the client wants to know about.

GetProtocolNames(RSelectItemArray &)

IMPORT_C TInt

GetProtocolNames

(

RSelectItemArray &

aNames

)

const

Parameters

RSelectItemArray & aNames

IsPictBridgeMode()

IMPORT_C TInt

IsPictBridgeMode

(

)

const

PictBridge USB mode checker

ReleaseEngine()

IMPORT_C TInt

ReleaseEngine

(

)

const

Releases DirectPrint engine

RemoveCachedPrinter(TInt)

IMPORT_C TInt

RemoveCachedPrinter

(

TInt

aPrinterID

)

const

Removes a specified cached printer.

Parameters

TInt aPrinterID

The exposed ID of the printer the client wants to remove.

ReserveEngine()

IMPORT_C TInt

ReserveEngine

(

)

const

Reserves DirectPrint engine for this client

SetForeground(TInt)

IMPORT_C TInt

SetForeground

(

TInt

aFg

)

const

Inform server about foreground/background state of the client

Parameters

TInt aFg

foreground/background flag

SetJobSetting(TInt, TInt, TInt &)

IMPORT_C TInt	SetJobSetting	(	TInt	aCapabilityID,
			TInt	aValue,
			TInt &	aAffectedCapability
		)	const

Sets a print job setting.

Parameters

TInt aCapabilityID	ID of the capability of interest.
TInt aValue	New capability value.
TInt & aAffectedCapability	ID of any affected capability.

SetNumberOfCopies(const RArray< TInt > &)

IMPORT_C TInt

SetNumberOfCopies

(

const RArray < TInt > &

aArray

)

const

Set number of copies

Parameters

const RArray < TInt > & aArray

array of number of copies elements. Each array element corresponds to the array of image file names of created print job

SubmitPrintJob()

IMPORT_C TInt

SubmitPrintJob

(

)

const

Submits a print job already created. The actual job execution is asynchronous so this function returns immediately. If successful, notification of job status and job completion is received by the client through the MPrintEventObserver.