Share via

INuiSensor::NuiImageStreamGetImageFrameFlags Method

  • Article

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Gets the image frame options.

Syntax

public:
HRESULT NuiImageStreamGetImageFrameFlags(
         HANDLE hStream,
         DWORD *pdwImageFrameFlags
)

Parameters

  • hStream
    Type: HANDLE
    [in] A handle to the stream.
  • pdwImageFrameFlags
    Type: DWORD
    A pointer to the variable that contains the image frame options.

Return Value

Type: HRESULT
Returns S_OK if successful; otherwise, returns one of the failure codes in the following table.

Error Description
E_INVALIDARG The value of hStream is NULL or invalid.
E_NUI_DEVICE_NOT_READY The device has not been initialized. Refer to NuiInitialize.
E_POINTER The value of pdwImageFrameFlags is NULL.

Requirements

Header: Declared in NuiSensor.h; however, include NuiApi.h in your project.