Share via

LASSGetValue (Compact 2013)

  • Article

3/28/2014

This function provides a method to query the LASS for values.

Syntax

BOOL LASSGetValue(
  DWORD ValueId,
  PVOID pOutBuffer,
  DWORD cbOutBuffer,
  DWORD* pcbReturned
);

Parameters

  • ValueId
    [in] The value the Local Authentication Plugin (LAP) wishes to query.
  • pOutBuffer
    [out] Pointer to the output buffer.
  • cbOutBuffer
    [in] Size of the output buffer in bytes.
  • pcbReturned
    [out] Pointer to the actual number of bytes of output. If the buffer specified by the pOutbuffer parameter is not large enough to hold the returned data, pcbReturned stores the required buffer size, in bytes.

Return Value

Returns TRUE if the value has been returned successfully, and FALSE otherwise. To get extended error information, the application should call GetLastError. The following table shows the most common error codes:

Value

Description

ERROR_INVALID_PARAMETER

One of the parameters contains an invalid value. This is most often an illegal pointer.

ERROR_MORE_DATA

If the buffer specified by the pOutbuffer parameter is not large enough to hold the returned data, the function sets the ERROR_MORE_DATA code, and stores the required buffer size, in bytes, into the variable pointed to by pcbReturned.

ERROR_UNKNOWN_PROPERTY

The ValueId parameter is not a valid Parameter Id.

Remarks

The values that can be queried are:

ValueID

Description

pOutBuffer

LASS_VALUE_DEVICE_WIPE_THRESHOLD

Returns the device wipe threshold. Returns 0 if no device wipe threshold is set.

Pointer to a DWORD

LASS_VALUE_AUTH_FAILURE_COUNT

Returns the number of authentication failures. If there have been no failures, This value returns 0.

Pointer to a DWORD

If the user wishes to query for the length of a value, they may do so by calling into LASSGetValue with a NULL output buffer.

Requirements

Header

lap.h

See Also

Reference

LASS Functions