VideoDeviceController.GetDevicePropertyByExtendedId(Byte[], Nullable<UInt32>) Method

Definition

Gets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and specifying the maximum buffer size required to store the result. You can use this method to query properties that are specific to a particular camera.

public:
 virtual VideoDeviceControllerGetDevicePropertyResult ^ GetDevicePropertyByExtendedId(Platform::Array <byte> ^ extendedPropertyId, IReference<unsigned int> ^ maxPropertyValueSize) = GetDevicePropertyByExtendedId;
VideoDeviceControllerGetDevicePropertyResult GetDevicePropertyByExtendedId(std::Array <byte> const & extendedPropertyId, IReference<uint32_t> const & maxPropertyValueSize);
public VideoDeviceControllerGetDevicePropertyResult GetDevicePropertyByExtendedId(byte[] extendedPropertyId, System.Nullable<uint> maxPropertyValueSize);
function getDevicePropertyByExtendedId(extendedPropertyId, maxPropertyValueSize)
Public Function GetDevicePropertyByExtendedId (extendedPropertyId As Byte(), maxPropertyValueSize As Nullable(Of UInteger)) As VideoDeviceControllerGetDevicePropertyResult

Parameters

extendedPropertyId
Byte[]

A byte array containing the extended identifier data.

maxPropertyValueSize
Nullable<UInt32>

The size of the buffer that should be allocated to store the result of the operation. If the driver does not require that a size be specified for the returned property, set this value to null. If the size is required, and you do not provide a value, the Status property of the returned VideoDeviceControllerGetDevicePropertyResult object will be MaxPropertyValueSizeRequired. If the value supplied is too small to store the result of the operation, the returned Status object will be MaxPropertyValueSizeTooSmall, which means that you can retry the call with a larger buffer size.

Returns

VideoDeviceControllerGetDevicePropertyResult

A VideoDeviceControllerGetDevicePropertyResult object containing the status of the operation and, if successful, the returned property value.

Windows 10 requirements

Device family
Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v4.0)

Applies to