BCCapture (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Use conditions
Managing errors
Application in the background: Android 10 specific case

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

BCCapture (Function)

In french: CBCapture

Decodes the information stored in a bar code by using the device camera (Android, iPhone, iPad).

Versions 21 and later

The Camera control can also be used to decode the bar codes directly. See Camera control: decoding the bar codes for more details.

New in version 21

The Camera control can also be used to decode the bar codes directly. See Camera control: decoding the bar codes for more details.

It is recommended to replace this function with an application window containing a Camera control that allows bar code decoding. See Camera control: decoding the bar codes for more details.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

New in version 18

This function is now available in Android Widget mode.

Versions 20 and later

Several types of bar codes are now supported (from iOS 7).

New in version 20

Several types of bar codes are now supported (from iOS 7).

Example

// Decode a QR Code bar code
bc is BarCode
bc = BCCapture()
IF ErrorOccurred = False _AND_ bc..TypeContent = bcTypeEmail THEN
Info("Email address: " + bc..RoughValue)
END

Syntax

<Result> = BCCapture([<Bar code type> [, <Enable flashlight>]])

<Result>: BarCode variable

BarCode variable initialized with the information read in the bar code.
Remark: The ..TypeBarCode property of the BarCode variable is not updated: it always corresponds to "QRCode".

<Bar code type>: Optional Integer constant

Type of bar code that can be decoded:
Versions 21 and later
BC_AZTEC
New in version 21
BC_AZTEC
BC_AZTEC Aztec bar code.
This type of bar code is available from iOS 7.
BC_CODE128 Code128 bar code.
This type of bar code is available from iOS 7.
BC_CODE39 Code39 bar code.
This type of bar code is available from iOS 7.
BC_CODE93 Code93 bar code.
This type of bar code is available from iOS 7.
BC_DATAMATRIX DATAMATRIX bar code.
Not available.
BC_EAN128 EAN128 bar code.
This type of bar code is available from iOS 7.
BC_EAN13 EAN13 bar code.
This type of bar code is available from iOS 7.
BC_EAN8 EAN8 bar code.
This type of bar code is available from iOS 7.
Versions 22 and later
BC_INTER2OF5
New in version 22
BC_INTER2OF5
BC_INTER2OF5 Interleaved 2 of 5 bar code.
This type of bar code is available from iOS 7.
BC_PDF417 PDF417 bar code.
This type of bar code is available from iOS 7.
Versions 16 and later
BC_QRCODE
New in version 16
BC_QRCODE
BC_QRCODE QR Code bar code.
BC_UPCA UPC-A bar code.
Not available.
BC_UPCE UPC-E bar code.
This type of bar code is available from iOS 7.
Versions 20 and later
BC_ALL
New in version 20
BC_ALL
BC_ALL All the types of bar codes supported by this function can be decoded.

If this parameter is not specified, all types of codes supported by this function can be decoded.
Versions 20 and later
From IOS 7, the following bar codes can be decoded: QR Code, UPCE, Code39, Code39Mod43, EAN13, EAN8, Code93, Code128, PDF417 and Aztec.
New in version 20
From IOS 7, the following bar codes can be decoded: QR Code, UPCE, Code39, Code39Mod43, EAN13, EAN8, Code93, Code128, PDF417 and Aztec.
From IOS 7, the following bar codes can be decoded: QR Code, UPCE, Code39, Code39Mod43, EAN13, EAN8, Code93, Code128, PDF417 and Aztec.

<Enable flashlight>: Optional boolean

Versions 20 and later
Mode for managing the flashlight:
True to enable the flashlight,
False (default value) to avoid activating the flashlight.
New in version 20
Mode for managing the flashlight:
True to enable the flashlight,
False (default value) to avoid activating the flashlight.
Mode for managing the flashlight:
True to enable the flashlight,
False (default value) to avoid activating the flashlight.

Remarks

Use conditions

In an Android application:

BCCapture opens a new window that displays the preview from the device camera. Then, you must:
- center the bar code to decode in the relevant area.
- validate like for a standard snapshot.
The Zxing library is used to decode bar codes (http://code.google.com/p/zxing). If this library is not found on the device, it will be automatically proposed for download. Caution: This library requires to use the landscape mode of device.

Versions 17 and later

For the iPhone/iPad applications:

BCCapture opens a new window that displays the preview from the device camera. Then, all you have to do is align the bar code to decode in the relevant area.
The window used to take the photos is included in the WINDEV Mobile application. No additional library is required.
Version earlier than iOS 7: Only the QR Code bar codes can be decoded. If another type of bar code is scanned, the decoding is not performed. The "Cancel" button found in the decoding window is used to close this window. In this case, the BarCode variable is not initialized.

New in version 17

For the iPhone/iPad applications:

BCCapture opens a new window that displays the preview from the device camera. Then, all you have to do is align the bar code to decode in the relevant area.
The window used to take the photos is included in the WINDEV Mobile application. No additional library is required.
Version earlier than iOS 7: Only the QR Code bar codes can be decoded. If another type of bar code is scanned, the decoding is not performed. The "Cancel" button found in the decoding window is used to close this window. In this case, the BarCode variable is not initialized.

For the iPhone/iPad applications:

BCCapture opens a new window that displays the preview from the device camera. Then, all you have to do is align the bar code to decode in the relevant area.
The window used to take the photos is included in the WINDEV Mobile application. No additional library is required.
Version earlier than iOS 7: Only the QR Code bar codes can be decoded. If another type of bar code is scanned, the decoding is not performed. The "Cancel" button found in the decoding window is used to close this window. In this case, the BarCode variable is not initialized.

Managing errors

To find out whether the bar code failed to be retrieved, use the ErrorOccurred variable.

The function will fail in the following cases:

if it is used in the simulator,
if it is used in the emulator,
if it is used in a device not equipped with a camera.
Versions 17 and later
if the "Cancel" button was used. In this case, the ..TypeBarCode property of the BarCode variable will be different from BC_QRCODE.
New in version 17
if the "Cancel" button was used. In this case, the ..TypeBarCode property of the BarCode variable will be different from BC_QRCODE.
if the "Cancel" button was used. In this case, the ..TypeBarCode property of the BarCode variable will be different from BC_QRCODE.

Versions 22 and later

If the bar code is decoded but its type is not recognized, the ..TypeBarCode property of the BarCode variable will correspond to the BC_UNKNOWN constant.

New in version 22

If the bar code is decoded but its type is not recognized, the ..TypeBarCode property of the BarCode variable will correspond to the BC_UNKNOWN constant.

Versions 25 and later

Application in the background: Android 10 specific case

From Android 10, it is no longer possible to open a window when the application is in the background.

BCCapture can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). When the notification is clicked on, the application will be brought back to the foreground if ..ActivateApplication is set to True. It is also possible to open a window from the procedure passed to ..ActionClick.

See Android 10: Behavior of applications in the background for more details.

New in version 25

Application in the background: Android 10 specific case

From Android 10, it is no longer possible to open a window when the application is in the background.

BCCapture can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). When the notification is clicked on, the application will be brought back to the foreground if ..ActivateApplication is set to True. It is also possible to open a window from the procedure passed to ..ActionClick.

See Android 10: Behavior of applications in the background for more details.

Application in the background: Android 10 specific case

From Android 10, it is no longer possible to open a window when the application is in the background.

BCCapture can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). When the notification is clicked on, the application will be brought back to the foreground if ..ActivateApplication is set to True. It is also possible to open a window from the procedure passed to ..ActionClick.

See Android 10: Behavior of applications in the background for more details.

Related Examples:

Cross-platform examples (WINDEV Mobile): WM Stocks

[ + ] This application is used to perform stocktaking and to save the results in a database.
The example is used to create entries/exits in the stock, by directly scanning the bar code of products.
It is optimized to be run on tablets.

Android (WINDEV Mobile): Android Inventory

[ + ] This application is used to perform inventories and to save the results in a database.

Business / UI classification : Neutral code

Component : wd260android.jar