Symbian^3 Application Developer Library >

IHLImageFactory Class Reference

class IHLImageFactory

IHLImageFactory

Static factory class for creating file instances. IHL.lib
Since
3.0
Public Member Functions
IMPORT_C MIHLFileImage * OpenBufferedFileImageL ( RFs &, const TDesC8 &)
IMPORT_C MIHLFileImage * OpenBufferedFileImageL ( RFs &, const TDesC8 &, TInt )
IMPORT_C MIHLFileImage * OpenBufferedFileImageL ( RFs &, const TDesC8 &, TInt , const TUint32 )
IMPORT_C MIHLFileImage * OpenFileImageL ( RFs &, const TDesC &)
IMPORT_C MIHLFileImage * OpenFileImageL ( RFs &, const TDesC &, TInt )
IMPORT_C MIHLFileImage * OpenFileImageL ( RFs &, const TDesC &, TInt , const TUint32 )
IMPORT_C MIHLFileImage * OpenFileImageL ( RFile &)
IMPORT_C MIHLFileImage * OpenFileImageL ( RFile &, TInt )
IMPORT_C MIHLFileImage * OpenFileImageL ( RFile &, TInt , const TUint32 )

Member Functions Documentation

OpenBufferedFileImageL(RFs &, const TDesC8 &)

IMPORT_C MIHLFileImage * OpenBufferedFileImageL ( RFs & aFs,
const TDesC8 & aDataBuf
) [static]
Create new image instance from buffered image data. Method leaves with appropriate error code if buffer data could not be used. If buffer contains multi-image, created image instance contains handle to the first image.
Since
3.0

Parameters

RFs & aFs Fileserver reference.
const TDesC8 & aDataBuf Buffer reference.

OpenBufferedFileImageL(RFs &, const TDesC8 &, TInt)

IMPORT_C MIHLFileImage * OpenBufferedFileImageL ( RFs & aFs,
const TDesC8 & aDataBuf,
TInt aImageIndex
) [static]
Create new image instance from buffered image data. Method leaves with appropriate error code if buffer data could not be used or image index is out of bounds. If buffer contains multi-image, created image instance contains handle to the first image.
Since
3.0

Parameters

RFs & aFs Fileserver reference.
const TDesC8 & aDataBuf Buffer reference.
TInt aImageIndex Image index. This is used in multi-image file to determine which image is opened.

OpenBufferedFileImageL(RFs &, const TDesC8 &, TInt, const TUint32)

IMPORT_C MIHLFileImage * OpenBufferedFileImageL ( RFs & aFs,
const TDesC8 & aDataBuf,
TInt aImageIndex,
const TUint32 aOptions
) [static]
Create new image instance from buffered image data. Method leaves with appropriate error code if buffer data could not be used or image index is out of bounds. If buffer contains multi-image, created image instance contains handle to the first image.
Since
3.0

Parameters

RFs & aFs Fileserver reference.
const TDesC8 & aDataBuf Buffer reference.
TInt aImageIndex Image index. This is used in multi-image file to determine which image is opened.
const TUint32 aOptions Special opening options. Refer to MIHLFileImage header.

OpenFileImageL(RFs &, const TDesC &)

IMPORT_C MIHLFileImage * OpenFileImageL ( RFs & aFs,
const TDesC & aFilename
) [static]

Open file and create new image instance. Default filemode is EFileShareReadersOnly and if opening fails, EFileShareAny is used. Method leaves with appropriate error code if file could not be opened. If file is multi-image, new image contains handle to the first image.

Note! Method may leave with KErrBadHandle if RFs::ShareProtected() method is not called!

Since
3.0

Parameters

RFs & aFs Fileserver reference.
const TDesC & aFilename Full path of image file.

OpenFileImageL(RFs &, const TDesC &, TInt)

IMPORT_C MIHLFileImage * OpenFileImageL ( RFs & aFs,
const TDesC & aFilename,
TInt aImageIndex
) [static]

Open file and create new image instance. Default filemode is EFileShareReadersOnly and if opening fails, EFileShareAny is used. Method leaves with appropriate error code if file could not be opened or index is out of bounds.

Note! Method may leave with KErrBadHandle if RFs::ShareProtected() method is not called!

Since
3.0

Parameters

RFs & aFs Fileserver reference.
const TDesC & aFilename Full path of image file.
TInt aImageIndex Image index. This is used in multi-image file to determine which image is opened.

OpenFileImageL(RFs &, const TDesC &, TInt, const TUint32)

IMPORT_C MIHLFileImage * OpenFileImageL ( RFs & aFs,
const TDesC & aFilename,
TInt aImageIndex,
const TUint32 aOptions
) [static]

Open file and create new image instance. Default filemode is EFileShareReadersOnly and if opening fails, EFileShareAny is used. Method leaves with appropriate error code if file could not be opened or index is out of bounds.

Note! Method may leave with KErrBadHandle if RFs::ShareProtected() method is not called!

Since
3.0

Parameters

RFs & aFs Fileserver reference.
const TDesC & aFilename Full path of image file.
TInt aImageIndex Image index. This is used in multi-image file to determine which image is opened.
const TUint32 aOptions Special opening options. Refer to MIHLFileImage header.

OpenFileImageL(RFile &)

IMPORT_C MIHLFileImage * OpenFileImageL ( RFile & aFile ) [static]
Create new image instance. Method leaves with appropriate error code if file type is unknown.
Since
3.0

Parameters

RFile & aFile Open file handle.

OpenFileImageL(RFile &, TInt)

IMPORT_C MIHLFileImage * OpenFileImageL ( RFile & aFile,
TInt aImageIndex
) [static]
Create new image instance. Method leaves with appropriate error code if file type is unknown or index is out of bounds.
Since
3.0

Parameters

RFile & aFile Open file handle.
TInt aImageIndex Image index. This is used in multi-image file to determine which image is opened.

OpenFileImageL(RFile &, TInt, const TUint32)

IMPORT_C MIHLFileImage * OpenFileImageL ( RFile & aFile,
TInt aImageIndex,
const TUint32 aOptions
) [static]
Create new image instance. Method leaves with appropriate error code if file type is unknown or index is out of bounds.
Since
3.0

Parameters

RFile & aFile Open file handle.
TInt aImageIndex Image index. This is used in multi-image file to determine which image is opened.
const TUint32 aOptions Special opening options. Refer to MIHLFileImage header.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.