Board.ReservePin(Int32, PinUsage, Object) Method

Reference

Definition

Namespace:: Iot.Device.Board

Assembly:: Iot.Device.Bindings.dll

Package:: Iot.Device.Bindings v1.5.0

Package:: Iot.Device.Bindings v2.0.0

Package:: Iot.Device.Bindings v2.1.0

Package:: Iot.Device.Bindings v3.0.0

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.

Reserves a pin for a specific usage. This is done automatically if a known interface (i.e. GpioController) is used to open the pin, but may be used to block a pin explicitly, i.e. for UART.

public virtual void ReservePin (int pinNumber, Iot.Device.Board.PinUsage usage, object owner);

abstract member ReservePin : int * Iot.Device.Board.PinUsage * obj -> unit
override this.ReservePin : int * Iot.Device.Board.PinUsage * obj -> unit

Public Overridable Sub ReservePin (pinNumber As Integer, usage As PinUsage, owner As Object)

Parameters

pinNumber: Int32

The pin number, in the boards default numbering scheme

usage: PinUsage

Intended usage of the pin

owner: Object

Class that owns the pin (use "this")

Exceptions

InvalidOperationException

The pin is already reserved

Applies to