![[Index]](../../../../a_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../a_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../a_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../a_stock/btn_next_wt.gif){kind=small}
|
|
|
|
|
|
||
Location:
obexheaders.h
Link against: obex.lib
class CObexHeader : public CBase;
Encapsulates an Obex header.
This class provides the ability to hold a header of any of the Obex supported types as a native Symbian OS type.
A header may also have one or more attributes set. These are used by the object which owns the header collection so that it can keep track of which headers should be sent (!(ESuppressed || EDeleted)), which have been sent (ESent), and whether the header should be deleted (EDeleted). Deletion is a special case---any operation on the Object which causes a scan of the headers will trigger deletion of any marked headers. This is required as they are owned by the Object, but can be accessed seperately (including through the creator keeping a pointer to the header).
CBase - Base class for all classes to be instantiated on the heap
CObexHeader - Encapsulates an Obex header
Defined in CObexHeader:
AsByte(), AsByteSeq(), AsFourByte(), AsUnicode(), Attributes(), CopyL(), EByte, EByteSeq, EDeleted, EFourByte, ESent, ESuppressed, EUnicode, EncodedSize(), HI(), NewL(), Reset(), ResetContents(), Set(), SetAttributes(), SetByte(), SetByteSeqL(), SetFourByte(), SetUnicodeL(), THeaderAttr, THeaderType, Type(), ~CObexHeader()
Inherited from CBase:
Delete(),
Extension_(),
operator new()
|
|
IMPORT_C CObexHeader *CopyL() const;
Return a pointer to a copy of this object. This must be used instead of merely copying the pointer to the initial CObexHeader object as reference counting is used to keep track of instances of the header. The underlying data is not cloned, so any change to the data pointed to by this pointer could change the underlying data.
|
IMPORT_C void Set(CObexHeader *aHeader);
Sets this object to use the same underlying header as the parameter. This performs essentially the same function as the CopyL() function, but does not allocate a new object. The underlying data is not cloned, so any change to the data pointed to by
this pointer could change the underlying data.
|
IMPORT_C void Reset();
Resets the contents of this header, discarding the underlying data. This is only called by the last instance of the header.
IMPORT_C void SetAttributes(TUint16 aAttr);
Sets the attibutes of this header.
|
IMPORT_C TUint16 Attributes() const;
Return the attibute set currently in force.
|
IMPORT_C THeaderType Type() const;
Return the type of this header.
|
IMPORT_C TUint8 AsByte() const;
Returns this header as a byte value.
|
|
IMPORT_C TUint32 AsFourByte() const;
Returns this header as a four-byte value.
|
|
IMPORT_C const TDesC8 &AsByteSeq() const;
Returns this header as a byte sequence.
|
|
IMPORT_C const TDesC16 &AsUnicode() const;
Returns this header as an Unicode string.
|
|
IMPORT_C void SetByte(const TUint8 aHI, const TUint8 aByte);
Sets this header to represent a byte value. Forces header type to be a byte (which may therefore change the HI value).
|
IMPORT_C void SetFourByte(const TUint8 aHI, const TUint32 aFourByte);
Sets this header to represent a four-byte value. Forces header type to be a four-byte (which may therefore change the HI value).
|
IMPORT_C void SetByteSeqL(const TUint8 aHI, const TDesC8 &aByteSeq);
Sets this header to represent a byte sequence. Forces header type to be a byte sequence (which may therefore change the HI value).
|
IMPORT_C void SetUnicodeL(const TUint8 aHI, const TDesC16 &aUnicode);
Forces header type to be a byte (which may therefore change the HI value).
|
IMPORT_C TInt EncodedSize() const;
|
|
|
|
Copyright ©2008 Symbian Software Ltd. |
|
![[Top]](../../../../a_stock/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/btn_prev.gif){kind=small}
![[Top]](../../../../a_stock/btn_top.gif)
![[Next]](../../../../a_stock/btn_next.gif){kind=small}