pcdprotocol_setboolean.md

PCD_PROTOCOL.SetBoolean()

Summary

Sets a Boolean value for a given PCD token.

Prototype

typedef
EFI_STATUS
(EFIAPI *PCD_PROTOCOL_SET_BOOLEAN) (
  IN UINTN    TokenNumber,
  IN BOOLEAN  Value
  );

Parameters

TokenNumber

The PCD token number.

Value

The value to set for the PCD token.

Description

When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned.

Status Codes Returned

Status Code	Description
EFI_SUCCESS	The PCD service has set the value requested
EFI_INVALID_PARAMETER	The PCD service determined that the size of the data being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data.
EFI_NOT_FOUND	The PCD service could not find the requested token number.