IMessaging.GetList()

Description:

The GetList method retrieves a list of messaging objects from the Messaging Center of the S60 device. Each object contains messaging information, that is, header and content data for a single message.

This is a synchronous method.

Syntax:

result = so.IMessaging.GetList(criteria);

Arguments:

  • criteria:

    This is an object that specifies what messaging information is returned and how the returned information is sorted. For more information about the object properties and how to define them, see section Criteria for retrieving messaging information.

Return value:

The GetList method returns an object that contains the requested messaging information, an error code, and an error message.

Table: Return value properties for GetList

Property

Description

Value

result.ReturnValue

This is an iterator that contains the requested messaging information.

See Returned messaging information.

result.ErrorCode

This is a number that specifies a predefined error code.

See Service API error codes.

result.ErrorMessage

This is a text string that describes the error.

See Messaging Service API error messages.

Remarks:

To access information about individual messages, iterate through the list of objects contained in result.ReturnValue.

Example code:

For the complete source of a sample widget that demonstrates how to use this Service API, see the full example.