AspriseImagingGetSource Method |
Retrieve the source info optionally with caps.
Namespace: asprise_imaging_apiAssembly: asprise-imaging-scan.net-api (in asprise-imaging-scan.net-api.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax public Source GetSource(
string sourceName,
bool nameOnly,
string capsToRetrieve = null,
bool getCurrent = false,
bool detectDeviceType = false,
string capsToSet = null
)
Public Function GetSource (
sourceName As String,
nameOnly As Boolean,
Optional capsToRetrieve As String = Nothing,
Optional getCurrent As Boolean = false,
Optional detectDeviceType As Boolean = false,
Optional capsToSet As String = Nothing
) As Source
public:
Source^ GetSource(
String^ sourceName,
bool nameOnly,
String^ capsToRetrieve = nullptr,
bool getCurrent = false,
bool detectDeviceType = false,
String^ capsToSet = nullptr
)
member GetSource :
sourceName : string *
nameOnly : bool *
?capsToRetrieve : string *
?getCurrent : bool *
?detectDeviceType : bool *
?capsToSet : string
(* Defaults:
let _capsToRetrieve = defaultArg capsToRetrieve null
let _getCurrent = defaultArg getCurrent false
let _detectDeviceType = defaultArg detectDeviceType false
let _capsToSet = defaultArg capsToSet null
*)
-> Source
Parameters
- sourceName
- Type: SystemString
the exact source name or "default" to open default source; "select" to prompt dialog selection - nameOnly
- Type: SystemBoolean
if true, return the device name only - capsToRetrieve (Optional)
- Type: SystemString
only effective if nameOnly is false - can be cap name or code separated by comma or 'all' to list all caps supported. - getCurrent (Optional)
- Type: SystemBoolean
true to return current value false to return current value as well as value range if available. - detectDeviceType (Optional)
- Type: SystemBoolean
detect whether the device has ADF and/or flatbed. - capsToSet (Optional)
- Type: SystemString
optionally, you may set capabilities before getting capabilities, e.g, 'ICAP_PIXELTYPE: TWPT_GRAY,TWPT_BW; ICAP_XSCALING/RESET; ICAP_XRESOLUTION: 200'
Return Value
Type:
SourceThe source object
See Also