SetPropertyBuffer Method

Summary

Fills the Stream buffer for any WiaVariableTypes.UI1 or WiaVariableTypes.Vector property.

Syntax

C++/CLI

Python

public void SetPropertyBuffer( 
   object item, 
   string propertyIdName, 
   WiaPropertyId propertyId, 
   Stream value 
)

public: 
void SetPropertyBuffer(  
   Object^ item, 
   String^ propertyIdName, 
   WiaPropertyId propertyId, 
   Stream^ value 
)

def SetPropertyBuffer(self,item,propertyIdName,propertyId,value):

Parameters

item
Handle to the item having the property. Retrieve this parameter by either calling the GetRootItem method to get the device's root item itself, or by enumerating the child items of the device through a call to EnumChildItems method.

propertyIdName
This string should contain the equivalent property Id string for the WIA property ID. Use the GetPropertyIdString method to get this string for the property ID.

If you passed null for this parameter, then the WIA toolkit will use the property ID passed through the third parameter,

propertyId; otherwise, this parameter will be used whether or not you passed valid property ID through the propertyId parameter

propertyId
The property ID for the value being sought. For a list of available property IDs, see WiaPropertyId.

This parameter is required only if the second parameter, propertyIdName, is null; otherwise, you can pass 0 for this parameter.

value
The WIA buffer value to set.

Remarks

Any WiaVariableTypes.UI1 or WiaVariableTypes.Vector property that is not Read only can be set by calling this method.

For more information, refer to Managing WIA Sources.

Example

Since there is no Read/Write buffer property of type WiaVariableTypes.UI1 or WiaVariableTypes.Vector until now, then we can't provide a sample for the SetPropertyBuffer method.

Requirements

Target Platforms