QPix Command Reference
![]() |
![]() ![]() |
QPx_AcqGetPicture(acqProtocol; deviceName; acquiredPicture; sessionOptions):error | |||
![]() |
acqProtocol | Longint | Acquisition protocol ID |
![]() |
deviceName | Text | Device name |
![]() |
acquiredPicture | Picture | Acquired picture |
![]() |
sessionOptions | Longint | Acquisition options (optional) |
![]() |
error | Longint | Error result |
Acquires a single image into a 4D picture variable.
Parameter acqProtocol specifies the protocol through which to acquire the picture. It can be one of the acquisition protocol ID constants:
qpx_AcqTWAINProtocol | 1 | TWAIN identifier |
qpx_AcqPictureTransferProtocol | 2 | Picture Transfer Protocol identifier |
qpx_AcqVideoProtocol | 4 | Video acquisition protocol identifier |
Parameter deviceName specifies the device from which to acquire the picture. To get all device names for a specific protocol, use the QPx_AcqGetDeviceList command. Alternatively, the QPx_AcqSelectDevice command can be used to let the user select the acquisition protocol and device.
After successful acquisition, QPx_AcqGetPicture returns qpx_NoErr and parameter acquiredPicture receives the acquired picture. If the user cancels the acquisition dialog, error qpx_userCancelErr is returned.
The optional parameter sessionOptions can be used to specify acquisition options. It can be a bitwise "or" combination of the following constants:
qpx_AcqHideDeviceGUI | 0x00000200 | Hide the device acquisition GUI (if supported). |
qpx_AcqTWAINEnableADF | 0x00010000 | Enable the use of the Automatic Document Feeder on TWAIN scanners (if supported). This option and qpx_AcqTWAINEnableTPU are mutually exclusive. |
qpx_AcqTWAINEnableTPU | 0x00100000 | Enable the use of the Automatic Document Feeder on TWAIN scanners (if supported). This option and qpx_AcqTWAINEnableADF are mutually exclusive. |
qpx_AcqPTPDeleteAfter | 0x00040000 | Delete the image on the PTP digital camera after acquisition (if supported). |
Note: not all protocols and devices support acquisition with the device dialog hidden:
If the qpx_AcqHideDeviceGUI option is specified and the device can not hide its dialog, this command runs the acquisition session with the device dialog visible.
Related commands
QPx_AcqGetSingleImage | Acquires a single image to a disk file. |
QPx_AcqGetMultipleImages | Acquires multiple images to disk files. |
QPx_AcqGetDeviceList | Returns all devices that are available through a specific acquisition protocol. |
QPx_AcqSelectDevice | Displays the acquisition protocol and device selection dialog. |