ISpThreadTask::InitThread

Microsoft Speech SDK

The Microsoft.com Speech website Microsoft Speech SDK SAPI 5.1

ISpThreadTask::InitThread

ISpThreadTask::InitThread is called on the allocated thread. If the method returns an error, the ISpThreadControl::StartThread method will fail.

This method is called on the newly allocated thread when ISpThreadControl::StartThread is called.

virtual HRESULT STDMETHODCALLTYPE InitThread(
   void   *pvTaskData,
   HWND    hwnd
) = 0;

Parameters

pvTaskData
[in] The same pointer is passed to ISpTaskManager::CreateThreadControl.
hwnd
[in] A window handle if, and only if, the caller to ISpTaskManager::CreateThreadControl specified that a window handle be created by passing a non-NULL HWND pointer to CreateThreadControl. Otherwise this parameter is NULL.

Return values

S_OK Function completed successfully.
Other success Success code will be returned to caller of the StartThread method and the thread will continue.
Failure code Function failed. Failure code will be returned to caller of the StartThread method and the thread will not continue.

Remarks

The caller of StartThread method will be blocked until the InitThread method completes, and the HRESULT returned from this method will be returned from StartThread. If the return code from this method indicates failure, the thread will be terminated, and ThreadProc and WindowMessage will never be called.