strpattern_cancel()

Cancel the pattern matching of a text.

Synopsis:

#include </strpattern.h>
 
void strpattern_cancel(long id, int *err)

Arguments:

id

The ID of the text whose pattern matching is to be canceled.

err

STRPATTERN_EOK if there is no error. STRPATTERN_ENOTFOUND if no text with the given ID is scheduled for pattern matching.

Library:

libstrpattern

Description:

This function cancels the pattern matching of a doucment or text with the specified ID. The ID is matched against the IDs assigned when texts are scheduled for pattern matching.

A scheduled pattern matching is canceled only if the pattern matching is not completed when this function executes.

Successfully cancelling a scheduled pattern matching means that the callback provided at the time of scheduling is not invoked for this instance of pattern matching.

Returns:

Last modified: 2013-12-21

comments powered by Disqus