WPD_COMMAND_STILL_IMAGE_CAPTURE_INITIATE Command

banner art

Previous Next

WPD_COMMAND_STILL_IMAGE_CAPTURE_INITIATE Command

The WPD_COMMAND_STILL_IMAGE_CAPTURE_INITIATE command initiates a still image capture by a still image functional object. If a new object is created as a result of taking a picture, the driver should send the WPD_EVENT_OBJECT_ADDED event.

Command category

WPD_CATEGORY_STILL_IMAGE_CAPTURE

Parameters

The driver expects the following parameters.

Parameter VarType Description
WPD_PROPERTY_COMMON_COMMAND_TARGET VT_LPWSTR Required. The object ID of the still image capture functional object on the device that should take the picture.

Each still image capture functional object can have different settings, and may refer to different hardware on a device (for example, a front or back camera of a phone), and this parameter indicates which one to use.

Return Values

The driver should return the following results.

Result VarType Description
WPD_PROPERTY_COMMON_HRESULT VT_ERROR Required. An HRESULT that indicates success or failure to carry out the command. If the caller is making an invalid request, the driver should return HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED) and is not required to return any other result values. Error codes include Windows Portable Devices error codes or any other appropriate error codes.
WPD_PROPERTY_COMMON_DRIVER_ERROR_CODE VT_UI4 Optional. A driver-specific error code. This value is typically used by device vendors to improve diagnosis of device errors while using their applications. General purpose applications would ignore it and rely solely on WPD_PROPERTY_COMMON_HRESULT instead.

Calling Methods

Can only be called directly using IPortableDevice::SendCommand.

Requirements

Header: Defined in PortableDevice.h

See Also

Previous Next