TIASResponse Class Reference

#include <ir_sock.h>

Link against: irda.lib

class TIASResponse : public TBuf8< KMaxQueryStringLength >

Inherits from

TIASResponse
- TBuf8< KMaxQueryStringLength >
  - TBufBase8
    - TDes8
      - TDesC8

Public Member Functions
	TIASResponse()
IMPORT_C TInt	GetCharString(TDes8 &, TInt)
IMPORT_C TInt	GetCharString(TDes16 &, TInt)
IMPORT_C const TPtrC16	GetCharString16(TInt)
IMPORT_C const TPtrC8	GetCharString8(TInt)
IMPORT_C TInt	GetInteger(TInt &, TInt)
IMPORT_C TInt	GetOctetSeq(TDes8 &, TInt)
IMPORT_C TBool	IsList()
IMPORT_C TInt	NumItems()
void	SetToCharString(const TDesC8 &)
void	SetToCharString(const TDesC16 &)
void	SetToInteger(TUint)
void	SetToOctetSeq(const TDesC8 &)
IMPORT_C TIASDataType	Type()

Inherited Attributes
	TBuf8< KMaxQueryStringLength >::iBuf
	TDes8::__DECLARE_TEST
	TDes8::iMaxLength

Inherited Functions
	TBuf8< KMaxQueryStringLength >::TBuf8()
	TBuf8< KMaxQueryStringLength >::TBuf8(TInt)
	TBuf8< KMaxQueryStringLength >::TBuf8(const TDesC8 &)
	TBuf8< KMaxQueryStringLength >::TBuf8(const TUint8 *)
	TBuf8< KMaxQueryStringLength >::operator=(const TBuf8< S > &)
	TBuf8< KMaxQueryStringLength >::operator=(const TDesC8 &)
	TBuf8< KMaxQueryStringLength >::operator=(const TUint8 *)
	TBufBase8::TBufBase8(TInt)
	TBufBase8::TBufBase8(TInt,TInt)
	TBufBase8::TBufBase8(const TDesC8 &,TInt)
	TBufBase8::TBufBase8(const TUint8 *,TInt)
	TDes8::Append(TChar)
	TDes8::Append(const TDesC16 &)
	TDes8::Append(const TDesC8 &)
	TDes8::Append(const TUint8 *,TInt)
	TDes8::AppendFill(TChar,TInt)
	TDes8::AppendFormat(TRefByValue< const TDesC8 >,...)
	TDes8::AppendFormat(TRefByValue< const TDesC8 >,TDes8Overflow *,...)
	TDes8::AppendFormatList(const TDesC8 &,VA_LIST,TDes8Overflow *)
	TDes8::AppendJustify(const TDesC8 &,TInt,TAlign,TChar)
	TDes8::AppendJustify(const TDesC8 &,TInt,TInt,TAlign,TChar)
	TDes8::AppendJustify(const TUint8 *,TInt,TAlign,TChar)
	TDes8::AppendJustify(const TUint8 *,TInt,TInt,TAlign,TChar)
	TDes8::AppendNum(TInt64)
	TDes8::AppendNum(TReal,const TRealFormat &)
	TDes8::AppendNum(TUint64,TRadix)
	TDes8::AppendNumFixedWidth(TUint,TRadix,TInt)
	TDes8::AppendNumFixedWidthUC(TUint,TRadix,TInt)
	TDes8::AppendNumUC(TUint64,TRadix)
	TDes8::Capitalize()
	TDes8::Collapse()
	TDes8::Collate()
	TDes8::Copy(const TDesC16 &)
	TDes8::Copy(const TDesC8 &)
	TDes8::Copy(const TUint8 *)
	TDes8::Copy(const TUint8 *,TInt)
	TDes8::CopyC(const TDesC8 &)
	TDes8::CopyCP(const TDesC8 &)
	TDes8::CopyF(const TDesC8 &)
	TDes8::CopyLC(const TDesC8 &)
	TDes8::CopyUC(const TDesC8 &)
	TDes8::Delete(TInt,TInt)
	TDes8::DoAppendNum(TUint64,TRadix,TUint,TInt)
	TDes8::DoPadAppendNum(TInt,TInt,const TUint8 *)
	TDes8::Expand()
	TDes8::Fill(TChar)
	TDes8::Fill(TChar,TInt)
	TDes8::FillZ()
	TDes8::FillZ(TInt)
	TDes8::Fold()
	TDes8::Format(TRefByValue< const TDesC8 >,...)
	TDes8::FormatList(const TDesC8 &,VA_LIST)
	TDes8::Insert(TInt,const TDesC8 &)
	TDes8::Justify(const TDesC8 &,TInt,TAlign,TChar)
	TDes8::LeftTPtr(TInt)const
	TDes8::LowerCase()
	TDes8::MaxLength()const
	TDes8::MaxSize()const
	TDes8::MidTPtr(TInt)const
	TDes8::MidTPtr(TInt,TInt)const
	TDes8::Num(TInt64)
	TDes8::Num(TReal,const TRealFormat &)
	TDes8::Num(TUint64,TRadix)
	TDes8::NumFixedWidth(TUint,TRadix,TInt)
	TDes8::NumFixedWidthUC(TUint,TRadix,TInt)
	TDes8::NumUC(TUint64,TRadix)
	TDes8::PtrZ()
	TDes8::Repeat(const TDesC8 &)
	TDes8::Repeat(const TUint8 *,TInt)
	TDes8::Replace(TInt,TInt,const TDesC8 &)
	TDes8::RightTPtr(TInt)const
	TDes8::SetLength(TInt)
	TDes8::SetMax()
	TDes8::Swap(TDes8 &)
	TDes8::TDes8()
	TDes8::TDes8(TInt,TInt,TInt)
	TDes8::Trim()
	TDes8::TrimAll()
	TDes8::TrimLeft()
	TDes8::TrimRight()
	TDes8::UpperCase()
	TDes8::WPtr()const
	TDes8::Zero()
	TDes8::ZeroTerminate()
	TDes8::operator+=(const TDesC8 &)
	TDes8::operator=(const TDes8 &)
	TDes8::operator[](TInt)
	TDes8::operator[](TInt)const
	TDesC8::Alloc()const
	TDesC8::AllocL()const
	TDesC8::AllocLC()const
	TDesC8::AtC(TInt)const
	TDesC8::Compare(const TDesC8 &)const
	TDesC8::CompareC(const TDesC8 &)const
	TDesC8::CompareF(const TDesC8 &)const
	TDesC8::DoSetLength(TInt)
	TDesC8::Find(const TDesC8 &)const
	TDesC8::Find(const TUint8 *,TInt)const
	TDesC8::FindC(const TDesC8 &)const
	TDesC8::FindC(const TUint8 *,TInt)const
	TDesC8::FindF(const TDesC8 &)const
	TDesC8::FindF(const TUint8 *,TInt)const
	TDesC8::Left(TInt)const
	TDesC8::Length()const
	TDesC8::Locate(TChar)const
	TDesC8::LocateF(TChar)const
	TDesC8::LocateReverse(TChar)const
	TDesC8::LocateReverseF(TChar)const
	TDesC8::Match(const TDesC8 &)const
	TDesC8::MatchC(const TDesC8 &)const
	TDesC8::MatchF(const TDesC8 &)const
	TDesC8::Mid(TInt)const
	TDesC8::Mid(TInt,TInt)const
	TDesC8::Ptr()const
	TDesC8::Right(TInt)const
	TDesC8::Size()const
	TDesC8::TDesC8()
	TDesC8::TDesC8(TInt,TInt)
	TDesC8::operator!=(const TDesC8 &)const
	TDesC8::operator<(const TDesC8 &)const
	TDesC8::operator<=(const TDesC8 &)const
	TDesC8::operator==(const TDesC8 &)const
	TDesC8::operator>(const TDesC8 &)const
	TDesC8::operator>=(const TDesC8 &)const

Detailed Description

Response from an Information Access Service (IAS) query to another device's IAS server.

Constructor & Destructor Documentation

TIASResponse ( )

IMPORT_C

TIASResponse

(

)

Default constructor. Marks the response type as missing.

Member Function Documentation

GetCharString ( TDes8 &, TInt )

IMPORT_C TInt	GetCharString	(	TDes8 &	aResult,
			TInt	anIndex = 0
		)	const

Returns the response string.

This is called if the response type indicates a string.

Parameters
aResult	On return, an 8 bit modifiable descriptor containing the response string. The length of the response string can never be greater than the value of (KMaxQueryStringLength - 3).
anIndex	Reserved for future use. This argument must be allowed to default to 0 and must not be overriden.

GetCharString ( TDes16 &, TInt )

IMPORT_C TInt	GetCharString	(	TDes16 &	aResult,
			TInt	anIndex = 0
		)	const

Gets the response string.

This is called if the response type indicates a string.

Parameters
aResult	On return, an 8 bit modifiable descriptor containing the response string. The length of the response string can never be greater than the value of (KMaxQueryStringLength - 3).
anIndex	Reserved for future use. This argument must be allowed to default to 0 and must not be overriden.

GetCharString16 ( TInt )

IMPORT_C const TPtrC16

GetCharString16

(

TInt

anIndex = 0

)

const

Gets a TPtrC16 string of unicode characters from the TIASResponse object.

GetCharString8 ( TInt )

IMPORT_C const TPtrC8

GetCharString8

(

TInt

anIndex = 0

)

const

Returns a non-modifiable pointer descriptor representing the response string.

This is called if the response type indicates a string.

Parameters
anIndex	Reserved for future use. This argument must be allowed to default to 0 and must not be overriden.

GetInteger ( TInt &, TInt )

IMPORT_C TInt	GetInteger	(	TInt &	aResult,
			TInt	anIndex = 0
		)	const

Returns the response integer.

This is called if the response type indicates an integer.

Parameters
aResult	On return, contains the 32-bit response integer value.
anIndex	Reserved for future use. This argument must be allowed to default to 0 and must not be overriden.

Return Value: KErrNone, if successful. KErrCorrupt, if the response type is not an integer.

GetOctetSeq ( TDes8 &, TInt )

IMPORT_C TInt	GetOctetSeq	(	TDes8 &	aResult,
			TInt	anIndex = 0
		)	const

Returns the response binary data.

Parameters
aResult	On return, contains the the binary data. The number of bytes returned can never be greater than (KMaxQueryStringLength - 3).
anIndex	Reserved for future use.

Return Value: KErrNone, if successful. KErrCorrupt, if the response type is not binary data. KErrNotSupported, if a non-zero value has been specified for anIndex.

IsList ( )

IMPORT_C TBool

IsList

(

)

const

Indicates the response contains a list.

NumItems ( )

IMPORT_C TInt

NumItems

(

)

const

Indicates the number of items in the response.

SetToCharString ( const TDesC8 & )

void

SetToCharString

(

const TDesC8 &

aCharString

)

SetToCharString ( const TDesC16 & )

void

SetToCharString

(

const TDesC16 &

aWideString

)

SetToInteger ( TUint )

void

SetToInteger

(

TUint

anInteger

)

SetToOctetSeq ( const TDesC8 & )

void

SetToOctetSeq

(

const TDesC8 &

aData

)

Type ( )

IMPORT_C TIASDataType

Type

(

)

const

Reimplemented from TDesC8::Type()const

Returns the type of the response.

Return Value: An enumeration identifying the type of response.