CreateControlInputEx function (corewindow.h)

Creates a ICoreInputSourceBase object in a worker thread or the UI thread.

Syntax

HRESULT CreateControlInputEx(
  [in]  IUnknown *pCoreWindow,
  [in]  REFIID   riid,
  [out] void     **ppv
);

Parameters

[in] pCoreWindow

Pointer to the parent CoreWindow to which the ICoreInputSourceBase object will be attached. This parameter can’t be NULL.

[in] riid

Interface ID of the object. Must to be set to the UUID for ICoreInputSourceBase, which is 9F488807-4580-4BE8-BE68-92A9311713BB.

[out] ppv

Pointer to receive the ICoreInputSourceBase object.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This API must be called from the UI thread or worker thread to create ICoreInputSourceBase object. The object created using this API can be used only in that thread in which it was created.

If the call is successful, the caller can call QueryInterface on the returned ICoreInputSourceBase object to obtain the ICoreInputInterop object that created it.

This API will fail if the following scenarios occur:

  • The pCoreWindow parameter is NULL.
  • If the CoreWindow passed is not same as the CoreWindow present in the calling thread.

Requirements

Requirement Value
Target Platform Windows
Header corewindow.h
DLL Windows.UI.dll

See also

ICoreInputSourceBase