ClaimedBarcodeScanner.SetActiveProfileAsync(String) Method

Reference

Definition

Namespace:: Windows.Devices.PointOfService

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Sets the active profile on the barcode scanner.

Important

This API applies only to Build 10240 and Build 10586 of the Windows Mobile device family (Windows Mobile Extensions for the UWP). This API doesn't apply to the Windows Desktop device family, nor to other device families, nor to builds of Windows Mobile other than 10240 and 10586. When called on an operating system (OS) to which it doesn't apply, the behavior of this API is undefined. For more info about device families, see Device family extension SDKs and API contracts.

public:
 virtual IAsyncAction ^ SetActiveProfileAsync(Platform::String ^ profile) = SetActiveProfileAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncAction SetActiveProfileAsync(winrt::hstring const& profile);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncAction SetActiveProfileAsync(string profile);

function setActiveProfileAsync(profile)

Public Function SetActiveProfileAsync (profile As String) As IAsyncAction

Parameters

profile: String
Platform::String

winrt::hstring

The name of the profile to set on the device.

Returns

IAsyncAction

No object or value is returned when the method completes.

Attributes: RemoteAsyncAttribute

Remarks

The input parameter must match one of the supported profiles. For more information, see GetSupportedProfiles or IsProfileSupported.

Barcode scanners can support a number of features beyond scanning, such as focal length and scan duration. These features are typically exposed through settings or properties and can be as many as 100 on complex devices. The simplify the model of scanner configuration, one or more profiles are exposed to application developers with each profile containing one or more OEM defined settings.

Applies to

Share via