TIASResponse Class Reference

#include <ir_sock.h>

Link against: irda.lib

class TIASResponse : public TBuf8< KMaxQueryStringLength >

Inherits from

  • TIASResponse
    Public Member Functions
    TIASResponse()
    IMPORT_C TIntGetCharString(TDes8 &, TInt)
    IMPORT_C TIntGetCharString(TDes16 &, TInt)
    IMPORT_C const TPtrC16GetCharString16(TInt)
    IMPORT_C const TPtrC8GetCharString8(TInt)
    IMPORT_C TIntGetInteger(TInt &, TInt)
    IMPORT_C TIntGetOctetSeq(TDes8 &, TInt)
    IMPORT_C TBoolIsList()
    IMPORT_C TIntNumItems()
    voidSetToCharString(const TDesC8 &)
    voidSetToCharString(const TDesC16 &)
    voidSetToInteger(TUint)
    voidSetToOctetSeq(const TDesC8 &)
    IMPORT_C TIASDataTypeType()
    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.

    See also: TIASQuery

    Constructor & Destructor Documentation

    TIASResponse ( )

    IMPORT_CTIASResponse()

    Default constructor. Marks the response type as missing.

    See also: TIASDataType

    Member Function Documentation

    GetCharString ( TDes8 &, TInt )

    IMPORT_C TIntGetCharString(TDes8 &aResult,
    TIntanIndex = 0
    )const

    Returns the response string.

    This is called if the response type indicates a string.

    See also: TIASResponse::Type()

    ParameterDescription
    aResultOn 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).
    anIndexReserved for future use. This argument must be allowed to default to 0 and must not be overriden.

    Returns: If successful, one of the TIASCharSet enumerator values defining the character set encoding of the response string. KErrNotSupported, if a non-zero value has been specified for anIndex. KErrCorrupt, if the response type is not a string.

    GetCharString ( TDes16 &, TInt )

    IMPORT_C TIntGetCharString(TDes16 &aResult,
    TIntanIndex = 0
    )const

    Gets the response string.

    This is called if the response type indicates a string.

    See also: TIASResponse::Type()

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

    ParameterDescription
    aResultOn 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).
    anIndexReserved for future use. This argument must be allowed to default to 0 and must not be overriden.

    Returns: If successful, one of the TIASCharSet enumerator values defining the character set encoding of the response string. KErrNotSupported, if a non-zero value has been specified for anIndex. KErrCorrupt, if the response type is not a string.

    GetCharString16 ( TInt )

    IMPORT_C const TPtrC16GetCharString16(TIntanIndex = 0)const

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

    GetCharString8 ( TInt )

    IMPORT_C const TPtrC8GetCharString8(TIntanIndex = 0)const

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

    This is called if the response type indicates a string.

    See also: TIASResponse::Type()

    ParameterDescription
    anIndexReserved for future use. This argument must be allowed to default to 0 and must not be overriden.

    Returns: A non-modifiable pointer descriptor representing the response string. If the response type is not a string or the string is flagged as being UNICODE, then this pointer descriptor is empty, i.e. it has zero length.

    GetInteger ( TInt &, TInt )

    IMPORT_C TIntGetInteger(TInt &aResult,
    TIntanIndex = 0
    )const

    Returns the response integer.

    This is called if the response type indicates an integer.

    ParameterDescription
    aResultOn return, contains the 32-bit response integer value.
    anIndexReserved for future use. This argument must be allowed to default to 0 and must not be overriden.

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

    GetOctetSeq ( TDes8 &, TInt )

    IMPORT_C TIntGetOctetSeq(TDes8 &aResult,
    TIntanIndex = 0
    )const

    Returns the response binary data.

    ParameterDescription
    aResultOn return, contains the the binary data. The number of bytes returned can never be greater than (KMaxQueryStringLength - 3).
    anIndexReserved for future use.

    Returns: 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 TBoolIsList()const

    Indicates the response contains a list.

    NumItems ( )

    IMPORT_C TIntNumItems()const

    Indicates the number of items in the response.

    SetToCharString ( const TDesC8 & )

    voidSetToCharString(const TDesC8 &aCharString)

    SetToCharString ( const TDesC16 & )

    voidSetToCharString(const TDesC16 &aWideString)

    SetToInteger ( TUint )

    voidSetToInteger(TUintanInteger)

    SetToOctetSeq ( const TDesC8 & )

    voidSetToOctetSeq(const TDesC8 &aData)

    Type ( )

    IMPORT_C TIASDataTypeType()const

    Reimplemented from TDesC8::Type()const

    Returns the type of the response.

    Returns: An enumeration identifying the type of response.

    © Nokia 2011.