ClaimedLineDisplay.TrySetDescriptorAsync Method

Definition

Attempts to asynchronously set a descriptor using the specified attribute.

public:
 virtual IAsyncOperation<bool> ^ TrySetDescriptorAsync(unsigned int descriptor, LineDisplayDescriptorState descriptorState) = TrySetDescriptorAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> TrySetDescriptorAsync(uint32_t const& descriptor, LineDisplayDescriptorState const& descriptorState);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> TrySetDescriptorAsync(uint descriptor, LineDisplayDescriptorState descriptorState);
function trySetDescriptorAsync(descriptor, descriptorState)
Public Function TrySetDescriptorAsync (descriptor As UInteger, descriptorState As LineDisplayDescriptorState) As IAsyncOperation(Of Boolean)

Parameters

descriptor
UInt32

unsigned int

uint32_t

The descriptor to be set. Must have a value between 0 and LineDisplayCapabilities.SupportedDescriptors - 1.

descriptorState
LineDisplayDescriptorState

The state to give to the descriptor.

Returns

Returns True if the descriptor was set successfully; otherwise, False.

Attributes

Windows requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

LineDisplayCapabilities.SupportedDescriptors must be greater than zero for this method to be successfully executed.

Applies to