ISpThreadTask::ThreadProc

This method implements the main processing loop of a thread. This method is application-specific.

virtual HRESULT STDMETHODCALLTYPE ThreadProc(
  void* pvTaskData,
  HANDLE hExitThreadEvent,
  HANDLE hNotifyEvent,
  HWND hwndWorker,
  volatile const BOOL* pfContinueProcessing
) = 0;

Parameters

  • pvTaskData
    [in] Pointer to task data. This data is the same as that passed to ISpTaskManager::CreateThreadControl.
  • hExitThreadEvent
    [in, out] Handle to event indicating that the thread process should exit.
  • hNotifyEvent
    [in] Handle to an auto-reset event that will be set if the ISpThreadControl::NotifyEvent method is called. This parameter applies to any notification event the client determines, or it can optionally be ignored.
  • hwndWorker
    [in] Window handle. This parameter is NULL if the caller of ISpThreadControl::StartThread passed in a null pointer to a window handle.
  • pfContinueProcessing
    [in] Pointer to a value indicating if processing should continue. Set this value to TRUE to continue processing, and to FALSE otherwise. This parameter is set to reflect the input setting of hExitThreadEvent.

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully.
S_FAILED Function failed.

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapiddk.h, Sapiddk.idl.
Link Library: Sapilib.lib.

See Also

ISpThreadTask | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.