SDK Home Glossary Index Left Right Up

IAS Response


Section contents


Overview

Defined in

csocket.oxh


Construction / destruction


NewIASResponse

Usage

this& = NewIASResponse&:

Description

Creates an IAS response object and returns a handle to the created object.

Return Value
this& A handle which represents the created IAS response object
Error Handling

If the object could not be created then an error is generated which should be trapped by an ONERR handler.

Example
  LOCAL this&

  this& = NewIASResponse&:
  DeleteIASResponse:(this&) 

DeleteIASResponse

Usage

DeleteIASResponse:(BYREF this&)

Description

Destroys the IAS response object.

Arguments
BYREF this& A handle for an IAS quetry object. A zero value is written back into the variable
Example
  LOCAL this$

  this& = NewIASResponse&:
  DeleteIASResponse:(this&) 

Methods provided


IASResponseGetCharString

Usage

err% = IASResponseGetCharString%:(this&,des&,index&)

Description

Returns the string value.

Arguments
this& A handle for an IAS response object
des& A handle to descriptor for the string
index& The index of the response value to be retrived
Return value
err% Return KErrNone% if the value is successfully returned.

IASResponseGetInteger

Usage

err% = IASResponseGetInteger%:(this&, BYREF result&,index&)

Description

Returns the intenger value.

Arguments
this& A handle for an IAS response object
BYREF result& Am integer value for the returned value
index& The index of the response value to be retrived
Return value
err% Return KErrNone% if the value is successfully returned.

IASResponseGetOctetSeq

Usage

err% = IASResponseGetOctetSeq%:(this&,des&,index&)

Description

Returns the octet sequence.

Arguments
this& A handle for an IAS response object
des& A handle to descriptor for the octet sequence
index& The index of the response value to be retrived
Return value
err% Return KErrNone% if the value is successfully returned.

IASResponseIsList

Usage

result% = IASResponseIsList%:(this&)

Description

<TBS>

Arguments
this& A handle for an IAS response object
Return value
result% <TBS>

IASResponseNumItems

Usage

count& = IASResponseNumItems&:(this&)

Description

Returns the number of items in the response.

Arguments
this& A handle for an IAS response object
Return value
count& The number of items in the reponse

IASResponseType

Usage

type& = IASResponseType&:(this&)

Description

Returns the type of the IAS Response.

Arguments
this& A handle for an IAS response object
Return value
type& An IAS Response type value
See also

IASQuery


  SDK Home Glossary Index Left Right Up