Include/Library/PcdLib.h

445   Returns the size of the token specified by TokenNumber and Guid.
446   If Guid is NULL, then ASSERT().
448   @param[in]  Guid          Pointer to a 128-bit unique value that designates
455 #define PcdGetExSize(Guid, TokenName)  LibPcdGetExSize ((Guid), PcdTokenEx(Guid,TokenName))  argument
552   Retrieves a token number based on a GUID and a token name.
554   Returns the token number for the token specified by Guid and TokenName.
557   @param   Guid        Pointer to a 128-bit unique value that designates
564 #define PcdTokenEx(Guid, TokenName)  _PCD_TOKEN_EX_##TokenName(Guid)  argument
567   Retrieves an 8-bit PCD token value based on a GUID and a token name.
569   Returns the 8-bit value for the token specified by Guid and TokenName.
570   If TokenName is not a valid token in the token space specified by Guid,
573   If Guid is NULL, then ASSERT().
575   @param   Guid        Pointer to a 128-bit unique value that designates
582 #define PcdGetEx8(Guid, TokenName)  LibPcdGetEx8 ((Guid), PcdTokenEx(Guid,TokenName))  argument
585   Retrieves a 16-bit PCD token value based on a GUID and a token name.
587   Returns the 16-bit value for the token specified by Guid and TokenName.
588   If TokenName is not a valid token in the token space specified by Guid,
591   If Guid is NULL, then ASSERT().
593   @param   Guid        Pointer to a 128-bit unique value that designates
600 #define PcdGetEx16(Guid, TokenName)  LibPcdGetEx16 ((Guid), PcdTokenEx(Guid,TokenName))  argument
603   Retrieves a 32-bit PCD token value based on a GUID and a token name.
605   Returns the 32-bit value for the token specified by Guid and TokenName.
606   If TokenName is not a valid token in the token space specified by Guid,
609   If Guid is NULL, then ASSERT().
611   @param   Guid        Pointer to a 128-bit unique value that designates
618 #define PcdGetEx32(Guid, TokenName)  LibPcdGetEx32 ((Guid), PcdTokenEx(Guid,TokenName))  argument
621   Retrieves a 64-bit PCD token value based on a GUID and a token name.
623   Returns the 64-bit value for the token specified by Guid and TokenName.
624   If TokenName is not a valid token in the token space specified by Guid,
627   If Guid is NULL, then ASSERT().
629   @param   Guid        Pointer to a 128-bit unique value that designates
636 #define PcdGetEx64(Guid, TokenName)  LibPcdGetEx64 ((Guid), PcdTokenEx(Guid,TokenName))  argument
639   Retrieves a pointer to a PCD token buffer based on a GUID and a token name.
641   Returns a pointer to the buffer for the token specified by Guid and TokenName.
642   If TokenName is not a valid token in the token space specified by Guid,
645   If Guid is NULL, then ASSERT().
647   @param   Guid        Pointer to a 128-bit unique value that designates
654 #define PcdGetExPtr(Guid, TokenName)  LibPcdGetExPtr ((Guid), PcdTokenEx(Guid,TokenName))  argument
657   Retrieves a Boolean PCD token value based on a GUID and a token name.
659   Returns the Boolean value for the token specified by Guid and TokenName.
660   If TokenName is not a valid token in the token space specified by Guid,
663   If Guid is NULL, then ASSERT().
665   @param   Guid        Pointer to a 128-bit unique value that designates
672 #define PcdGetExBool(Guid, TokenName)  LibPcdGetExBool  ((Guid), PcdTokenEx(Guid,TokenName))  argument
675   Sets an 8-bit PCD token value based on a GUID and a token name.
677   Sets the 8-bit value for the token specified by Guid and TokenName.
678   If TokenName is not a valid token in the token space specified by Guid,
681   If Guid is NULL, then ASSERT().
683   @param Guid       Pointer to a 128-bit unique value that designates
691 #define PcdSetEx8S(Guid, TokenName, Value)  LibPcdSetEx8S ((Guid), PcdTokenEx(Guid,TokenName), (Val…  argument
694   Sets an 16-bit PCD token value based on a GUID and a token name.
696   Sets the 16-bit value for the token specified by Guid and TokenName.
697   If TokenName is not a valid token in the token space specified by Guid,
700   If Guid is NULL, then ASSERT().
702   @param Guid       Pointer to a 128-bit unique value that designates
710 #define PcdSetEx16S(Guid, TokenName, Value)  LibPcdSetEx16S ((Guid), PcdTokenEx(Guid,TokenName), (V…  argument
713   Sets an 32-bit PCD token value based on a GUID and a token name.
715   Sets the 32-bit value for the token specified by Guid and TokenName.
716   If TokenName is not a valid token in the token space specified by Guid,
719   If Guid is NULL, then ASSERT().
721   @param Guid       Pointer to a 128-bit unique value that designates
729 #define PcdSetEx32S(Guid, TokenName, Value)  LibPcdSetEx32S ((Guid), PcdTokenEx(Guid,TokenName), (V…  argument
732   Sets an 64-bit PCD token value based on a GUID and a token name.
734   Sets the 64-bit value for the token specified by Guid and TokenName.
735   If TokenName is not a valid token in the token space specified by Guid,
738   If Guid is NULL, then ASSERT().
740   @param Guid       Pointer to a 128-bit unique value that designates
748 #define PcdSetEx64S(Guid, TokenName, Value)  LibPcdSetEx64S ((Guid), PcdTokenEx(Guid,TokenName), (V…  argument
751   Sets a pointer to a PCD token buffer based on a GUID and a token name.
753   Sets the buffer for the token specified by Guid and TokenName.
754   If SizeOfBuffer is greater than the maximum size supported by Guid and TokenName,
755   then set SizeOfBuffer to the maximum size supported by Guid and TokenName and return
758   supported by Guid and TokenName and RETURN_INVALID_PARAMETER must be returned.
759   If TokenName is not a valid token in the token space specified by Guid,
762   If Guid is NULL, then ASSERT().
766   @param Guid           Pointer to a 128-bit unique value that designates
775 #define PcdSetExPtrS(Guid, TokenName, SizeOfBuffer, Buffer) \  argument
776 …                     LibPcdSetExPtrS ((Guid), PcdTokenEx(Guid,TokenName), (SizeOfBuffer), (Buffer))
779   Sets an boolean PCD token value based on a GUID and a token name.
781   Sets the boolean value for the token specified by Guid and TokenName.
782   If TokenName is not a valid token in the token space specified by Guid,
785   If Guid is NULL, then ASSERT().
787   @param Guid       Pointer to a 128-bit unique value that designates
795 #define PcdSetExBoolS(Guid, TokenName, Value) \  argument
796 …                                     LibPcdSetExBoolS ((Guid), PcdTokenEx(Guid,TokenName), (Value))
928   Returns the 8-bit value for the token specified by TokenNumber and Guid.
930   If Guid is NULL, then ASSERT().
932   @param[in]  Guid         Pointer to a 128-bit unique value that designates
942   IN CONST GUID  *Guid,
949   Returns the 16-bit value for the token specified by TokenNumber and Guid.
951   If Guid is NULL, then ASSERT().
953   @param[in]  Guid         Pointer to a 128-bit unique value that designates
963   IN CONST GUID  *Guid,
968   Returns the 32-bit value for the token specified by TokenNumber and Guid.
969   If Guid is NULL, then ASSERT().
971   @param[in]  Guid         Pointer to a 128-bit unique value that designates
981   IN CONST GUID  *Guid,
988   Returns the 64-bit value for the token specified by TokenNumber and Guid.
990   If Guid is NULL, then ASSERT().
992   @param[in]  Guid          Pointer to a 128-bit unique value that designates
1002   IN CONST GUID  *Guid,
1009   Returns the pointer to the buffer of token specified by TokenNumber and Guid.
1011   If Guid is NULL, then ASSERT().
1013   @param[in]  Guid          Pointer to a 128-bit unique value that designates
1023   IN CONST GUID  *Guid,
1030   Returns the Boolean value of the token specified by TokenNumber and Guid.
1032   If Guid is NULL, then ASSERT().
1034   @param[in]  Guid          Pointer to a 128-bit unique value that designates
1044   IN CONST GUID  *Guid,
1051   Returns the size of the token specified by TokenNumber and Guid.
1053   If Guid is NULL, then ASSERT().
1055   @param[in]  Guid          Pointer to a 128-bit unique value that designates
1065   IN CONST GUID  *Guid,
1200   If Guid is NULL, then ASSERT().
1202   @param[in] Guid           The pointer to a 128-bit unique value that
1213   IN CONST GUID  *Guid,
1224   If Guid is NULL, then ASSERT().
1226   @param[in] Guid           The pointer to a 128-bit unique value that
1237   IN CONST GUID  *Guid,
1248   If Guid is NULL, then ASSERT().
1250   @param[in] Guid           The pointer to a 128-bit unique value that
1261   IN CONST GUID  *Guid,
1272   If Guid is NULL, then ASSERT().
1274   @param[in] Guid           The pointer to a 128-bit unique value that
1285   IN CONST GUID  *Guid,
1299   If Guid is NULL, then ASSERT().
1303   @param[in]      Guid          Pointer to a 128-bit unique value that
1315   IN CONST GUID   *Guid,
1327   If Guid is NULL, then ASSERT().
1329   @param[in] Guid           The pointer to a 128-bit unique value that
1340   IN CONST GUID  *Guid,
1355   @param[in]      CallBackGuid    The PCD token GUID being set.
1364   IN        CONST GUID        *CallBackGuid  OPTIONAL,
1373   When the token specified by TokenNumber and Guid is set,
1375   If Guid is NULL, then the default token space is used.
1378   @param[in]  Guid                  Pointer to a 128-bit unique value that designates which
1383                                     specified by Guid and TokenNumber is set.
1389   IN CONST GUID    *Guid        OPTIONAL,
1399   If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
1402   @param[in]  Guid                 Specify the GUID token space.
1410   IN CONST GUID    *Guid        OPTIONAL,
1418   Retrieves the next PCD token number from the token space specified by Guid.
1419   If Guid is NULL, then the default token space is used.  If TokenNumber is 0,
1424   If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().
1426   @param[in]  Guid        Pointer to a 128-bit unique value that designates which namespace
1437   IN CONST GUID  *Guid        OPTIONAL,
1444   Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces
1447   If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.
1449   @param  TokenSpaceGuid  Pointer to the a PCD token space GUID
1454 GUID *
1457   IN CONST GUID  *TokenSpaceGuid
1617   /// ASCII string associated with the token's namespace Guid. If NULL, there is no
1648   If TokenNumber is not in the token space specified by Guid, then ASSERT().
1650 …@param[in]    Guid        The 128-bit unique value that designates the namespace from which to ext…
1658   IN CONST  GUID      *Guid,