ILocation.CancelNotification()

Description:

The CancelNotification method cancels an outstanding asynchronous call.

This is a synchronous method.

Syntax:

result = so.ILocation.CancelNotification(criteria);

Arguments:

  • criteria:

    This is an object that specifies whether to cancel a GetLocation call or a Trace call. The object must contain the CancelRequestType property (string) that is used to specify the type of call to cancel. The possible values for criteria.CancelRequestType are:

    • "GetLocCancel" cancels an asynchronous GetLocation call.

    • "TraceCancel" cancels a Trace call.

Return value:

The CancelNotification method returns an object that contains an error code and an error message.

Table: Return value properties for CancelNotification

Property

Description

Value

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 Location Service API error messages.

Example code:

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