Jump to main content

##

# 2.51.15 GPIO_PinLatchRead Function

## C

    bool GPIO_PinLatchRead ( GPIO_PIN pin )

## Summary

Read the value driven on the selected pin.

## Description

This function reads the data driven on the selected I/O line/pin. Whatever data is written/driven on I/O line by using any of the GPIO PLIB APIs, will be read by this API.

## Precondition

None.

## Parameters

Param | Description
--- | ---
pin | One of the IO pins from the enum GPIO_PIN

## Returns

Returns the latch value of the selected pin. - True - Latch value is 1.

- False - Latch value is 0.

## Example

    bool value;
    value = GPIO_PinLatchRead(GPIO_PIN_RB3);

## Remarks

To read actual pin value, GPIO_PinRead API should be used.