Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]

Location: ir_sock.h
Link against: irda.lib

Class TIASResponse

class TIASResponse : public TBuf8< KMaxQueryStringLength >;

Description

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

Derivation

Members

Defined in TIASResponse:
GetCharString(), GetCharString(), GetCharString16(), GetCharString8(), GetInteger(), GetOctetSeq(), IsList(), NumItems(), TIASResponse(), Type()

See also:

Construction and destruction

TIASResponse()

IMPORT_C TIASResponse();

Description

Default constructor. Marks the response type as missing.

See also:

[Top]

Member functions

IsList()

IMPORT_C TBool IsList() const;

Description

Indicates the response contains a list.

Return value

TBool

NumItems()

IMPORT_C TInt NumItems() const;

Description

Indicates the number of items in the response.

Return value

TInt

Type()

IMPORT_C TIASDataType Type() const;

Description

Returns the type of the response.

Return value

TIASDataType

An enumeration identifying the type of response.

GetInteger()

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

Description

Returns the response integer.

This is called if the response type indicates an integer.

Parameters

TInt &aResult

On return, contains the 32-bit response integer value.

TInt anIndex

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

Return value

TInt

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

GetOctetSeq()

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

Description

Returns the response binary data.

Parameters

TDes8 &aResult

On return, contains the the binary data. The number of bytes returned can never be greater than (KMaxQueryStringLength - 3).

TInt anIndex

Reserved for future use.

Return value

TInt

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

GetCharString()

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

Description

Returns the response string.

This is called if the response type indicates a string.

Parameters

TDes8 &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).

TInt anIndex

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

Return value

TInt

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.

See also:

GetCharString8()

IMPORT_C const TPtrC8 GetCharString8(TInt anIndex=0) const;

Description

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

This is called if the response type indicates a string.

Parameters

TInt anIndex

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

Return value

const TPtrC8

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.

See also:

GetCharString()

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

Description

Gets the response string.

This is called if the response type indicates a string.

Parameters

TDes16 &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).

TInt anIndex

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

Return value

TInt

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.

See also:

GetCharString16()

IMPORT_C const TPtrC16 GetCharString16(TInt anIndex=0) const;

Description

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

Parameters

TInt anIndex

Return value

const TPtrC16

[Previous] [Top] [Next]