Include/Library/PcdLib.h

26   Retrieves a token number based on a token name.
28   Returns the token number associated with the PCD token specified by TokenName.
29   If TokenName is not a valid token in the token space, then the module will not build.
31   @param   TokenName  The name of the PCD token to retrieve the token number for.
33   @return  The token number associated with the PCD.
39   Retrieves a Boolean PCD feature flag based on a token name.
42   If TokenName is not a valid token in the token space, then the module will not build.
45   @param   TokenName  The name of the PCD token to retrieve a current value for.
53   Retrieves an 8-bit fixed PCD token value based on a token name.
55   Returns the 8-bit value for the token specified by TokenName.
56   If TokenName is not a valid token in the token space, then the module will not build.
59   @param   TokenName  The name of the PCD token to retrieve a current value for.
61   @return  8-bit value for the token specified by TokenName.
67   Retrieves a 16-bit fixed PCD token value based on a token name.
69   Returns the 16-bit value for the token specified by TokenName.
70   If TokenName is not a valid token in the token space, then the module will not build.
73   @param   TokenName  The name of the PCD token to retrieve a current value for.
75   @return  16-bit value for the token specified by TokenName.
81   Retrieves a 32-bit fixed PCD token value based on a token name.
83   Returns the 32-bit value for the token specified by TokenName.
84   If TokenName is not a valid token in the token space, then the module will not build.
87   @param   TokenName  The name of the PCD token to retrieve a current value for.
89   @return  32-bit value for the token specified by TokenName.
95   Retrieves a 64-bit fixed PCD token value based on a token name.
97   Returns the 64-bit value for the token specified by TokenName.
98   If TokenName is not a valid token in the token space, then the module will not build.
101   @param   TokenName  The name of the PCD token to retrieve a current value for.
103   @return  64-bit value for the token specified by TokenName.
109   Retrieves a Boolean fixed PCD token value based on a token name.
111   Returns the Boolean value for the token specified by TokenName.
112   If TokenName is not a valid token in the token space, then the module will not build.
115   @param   TokenName  The name of the PCD token to retrieve a current value for.
117   @return  The Boolean value for the token.
123   Retrieves a pointer to a fixed PCD token buffer based on a token name.
125   Returns a pointer to the buffer for the token specified by TokenName.
126   If TokenName is not a valid token in the token space, then the module will not build.
129   @param   TokenName  The name of the PCD token to retrieve a current value for.
137   Retrieves an 8-bit binary patchable PCD token value based on a token name.
139   Returns the 8-bit value for the token specified by TokenName.
140   If TokenName is not a valid token in the token space, then the module will not build.
143   @param   TokenName  The name of the PCD token to retrieve a current value for.
145   @return  An 8-bit binary patchable PCD token value.
151   Retrieves a 16-bit binary patchable PCD token value based on a token name.
153   Returns the 16-bit value for the token specified by TokenName.
154   If TokenName is not a valid token in the token space, then the module will not build.
157   @param   TokenName  The name of the PCD token to retrieve a current value for.
159   @return  A 16-bit binary patchable PCD token value.
165   Retrieves a 32-bit binary patchable PCD token value based on a token name.
167   Returns the 32-bit value for the token specified by TokenName.
168   If TokenName is not a valid token in the token space, then the module will not build.
171   @param   TokenName  The name of the PCD token to retrieve a current value for.
173   @return  A 32-bit binary patchable PCD token value.
179   Retrieves a 64-bit binary patchable PCD token value based on a token name.
181   Returns the 64-bit value for the token specified by TokenName.
182   If TokenName is not a valid token in the token space, then the module will not build.
185   @param   TokenName  The name of the PCD token to retrieve a current value for.
187   @return  A 64-bit binary patchable PCD token value.
193   Retrieves a Boolean binary patchable PCD token value based on a token name.
195   Returns the Boolean value for the token specified by TokenName.
196   If TokenName is not a valid token in the token space, then the module will not build.
199   @param   TokenName  The name of the PCD token to retrieve a current value for.
201   @return  The Boolean value for the token.
207   Retrieves a pointer to a binary patchable PCD token buffer based on a token name.
209   Returns a pointer to the buffer for the token specified by TokenName.
210   If TokenName is not a valid token in the token space, then the module will not build.
213   @param   TokenName  The name of the PCD token to retrieve a current value for.
215   @return  A pointer to the buffer for the token.
221   Sets an 8-bit binary patchable PCD token value based on a token name.
223   Sets the 8-bit value for the token specified by TokenName. Value is returned.
224   If TokenName is not a valid token in the token space, then the module will not build.
227   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
236   Sets a 16-bit binary patchable PCD token value based on a token name.
238   Sets the 16-bit value for the token specified by TokenName. Value is returned.
239   If TokenName is not a valid token in the token space, then the module will not build.
242   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
251   Sets a 32-bit binary patchable PCD token value based on a token name.
253   Sets the 32-bit value for the token specified by TokenName. Value is returned.
254   If TokenName is not a valid token in the token space, then the module will not build.
257   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
266   Sets a 64-bit binary patchable PCD token value based on a token name.
268   Sets the 64-bit value for the token specified by TokenName. Value is returned.
269   If TokenName is not a valid token in the token space, then the module will not build.
272   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
281   Sets a Boolean binary patchable PCD token value based on a token name.
283   Sets the Boolean value for the token specified by TokenName. Value is returned.
284   If TokenName is not a valid token in the token space, then the module will not build.
287   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
296   Sets a pointer to a binary patchable PCD token buffer based on a token name.
298   Sets the buffer for the token specified by TokenName.  Buffer is returned.
303   If TokenName is not a valid token in the token space, then the module will not build.
309   @param   TokenName      The name of the binary patchable PCD token to set the current value for.
326   Retrieves an 8-bit PCD token value based on a token name.
328   Returns the 8-bit value for the token specified by TokenName.
329   If TokenName is not a valid token in the token space, then the module will not build.
331   @param   TokenName  The name of the PCD token to retrieve a current value for.
333   @return  8-bit value for the token specified by TokenName.
339   Retrieves a 16-bit PCD token value based on a token name.
341   Returns the 16-bit value for the token specified by TokenName.
342   If TokenName is not a valid token in the token space, then the module will not build.
344   @param   TokenName  The name of the PCD token to retrieve a current value for.
346   @return  16-bit value for the token specified by TokenName.
352   Retrieves a 32-bit PCD token value based on a token name.
354   Returns the 32-bit value for the token specified by TokenName.
355   If TokenName is not a valid token in the token space, then the module will not build.
357   @param   TokenName  The name of the PCD token to retrieve a current value for.
359   @return  32-bit value for the token specified by TokenName.
365   Retrieves a 64-bit PCD token value based on a token name.
367   Returns the 64-bit value for the token specified by TokenName.
368   If TokenName is not a valid token in the token space, then the module will not build.
370   @param   TokenName  The name of the PCD token to retrieve a current value for.
372   @return  64-bit value for the token specified by TokenName.
378   Retrieves a pointer to a PCD token buffer based on a token name.
380   Returns a pointer to the buffer for the token specified by TokenName.
381   If TokenName is not a valid token in the token space, then the module will not build.
383   @param   TokenName  The name of the PCD token to retrieve a current value for.
391   Retrieves a Boolean PCD token value based on a token name.
393   Returns the Boolean value for the token specified by TokenName.
394   If TokenName is not a valid token in the token space, then the module will not build.
396   @param   TokenName  The name of the PCD token to retrieve a current value for.
398   @return  A Boolean PCD token value.
404   Retrieves the size of a fixed PCD token based on a token name.
406   Returns the size of the token specified by TokenName.
407   If TokenName is not a valid token in the token space, then the module will not build.
409   @param[in]  TokenName  The name of the PCD token to retrieve a current value size for.
417   Retrieves the size of a binary patchable PCD token based on a token name.
419   Returns the size of the token specified by TokenName.
420   If TokenName is not a valid token in the token space, then the module will not build.
422   @param[in]  TokenName  The name of the PCD token to retrieve a current value size for.
430   Retrieves the size of the PCD token based on a token name.
432   Returns the size of the token specified by TokenName.
433   If TokenName is not a valid token in the token space, then the module will not build.
435   @param[in]   TokenName  The name of the PCD token to retrieve a current value size for.
443   Retrieve the size of a given PCD token.
445   Returns the size of the token specified by TokenNumber and Guid.
450   @param[in]  TokenNumber   The PCD token number to retrieve a current value size for.
458   Sets a 8-bit PCD token value based on a token name.
460   Sets the 8-bit value for the token specified by TokenName.
461   If TokenName is not a valid token in the token space, then the module will not build.
463   @param TokenName  The name of the PCD token to retrieve a current value for.
472   Sets a 16-bit PCD token value based on a token name.
474   Sets the 16-bit value for the token specified by TokenName.
475   If TokenName is not a valid token in the token space, then the module will not build.
477   @param TokenName  The name of the PCD token to retrieve a current value for.
486   Sets a 32-bit PCD token value based on a token name.
488   Sets the 32-bit value for the token specified by TokenName.
489   If TokenName is not a valid token in the token space, then the module will not build.
491   @param TokenName  The name of the PCD token to retrieve a current value for.
500   Sets a 64-bit PCD token value based on a token name.
502   Sets the 64-bit value for the token specified by TokenName.
503   If TokenName is not a valid token in the token space, then the module will not build.
505   @param TokenName  The name of the PCD token to retrieve a current value for.
514   Sets a pointer to a PCD token buffer based on a token name.
516   Sets the buffer for the token specified by TokenName.
522   If TokenName is not a valid token in the token space, then the module will not build.
527   @param TokenName      The name of the PCD token to set the current value for.
538   Sets a boolean PCD token value based on a token name.
540   Sets the boolean value for the token specified by TokenName.
541   If TokenName is not a valid token in the token space, then the module will not build.
543   @param TokenName  The name of the PCD token to retrieve a current value for.
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.
555   If TokenName is not a valid token in the token space, then the module will not build.
559   @param   TokenName   The name of the PCD token to retrieve a current value for.
561   @return  Return the token number.
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,
577   @param   TokenName   The name of the PCD token to retrieve a current value for.
579   @return  An 8-bit PCD token value.
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,
595   @param   TokenName   The name of the PCD token to retrieve a current value for.
597   @return  A 16-bit PCD token value.
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,
613   @param   TokenName   The name of the PCD token to retrieve a current value for.
615   @return  A 32-bit PCD token value.
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,
631   @param   TokenName   The name of the PCD token to retrieve a current value for.
633   @return  A 64-bit PCD token value.
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,
649   @param   TokenName   The name of the PCD token to retrieve a current value for.
651   @return  A pointer to a PCD token buffer.
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,
667   @param   TokenName   The name of the PCD token to retrieve a current value for.
669   @return  A Boolean PCD token value.
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,
685   @param TokenName  The name of the PCD token to set the current value for.
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,
704   @param TokenName  The name of the PCD token to set the current value for.
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,
723   @param TokenName  The name of the PCD token to set the current value for.
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,
742   @param TokenName  The name of the PCD token to set the current value for.
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.
759   If TokenName is not a valid token in the token space specified by Guid,
768   @param TokenName      The name of the PCD token to set the current value for.
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,
789   @param TokenName  The name of the PCD token to set the current value for.
804                   associated with a PCD token.
816   This function provides a means by which to retrieve a value for a given PCD token.
818   Returns the 8-bit value for the token specified by TokenNumber.
820   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
822   @return Returns the 8-bit value for the token specified by TokenNumber.
832   This function provides a means by which to retrieve a value for a given PCD token.
834   Returns the 16-bit value for the token specified by TokenNumber.
836   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
838   @return Returns the 16-bit value for the token specified by TokenNumber.
848   This function provides a means by which to retrieve a value for a given PCD token.
850   Returns the 32-bit value for the token specified by TokenNumber.
852   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
854   @return Returns the 32-bit value for the token specified by TokenNumber.
864   This function provides a means by which to retrieve a value for a given PCD token.
866   Returns the 64-bit value for the token specified by TokenNumber.
868   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
870   @return Returns the 64-bit value for the token specified by TokenNumber.
880   This function provides a means by which to retrieve a value for a given PCD token.
882   Returns the pointer to the buffer of the token specified by TokenNumber.
884   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
886   @return Returns the pointer to the token specified by TokenNumber.
896   This function provides a means by which to retrieve a value for a given PCD token.
898   Returns the Boolean value of the token specified by TokenNumber.
900   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
902   @return Returns the Boolean value of the token specified by TokenNumber.
912   This function provides a means by which to retrieve the size of a given PCD token.
914   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
916   @return Returns the size of the token specified by TokenNumber.
926   This function provides a means by which to retrieve a value for a given PCD token.
928   Returns the 8-bit value for the token specified by TokenNumber and Guid.
934   @param[in]  TokenNumber  The PCD token number to retrieve a current value for.
947   This function provides a means by which to retrieve a value for a given PCD token.
949   Returns the 16-bit value for the token specified by TokenNumber and Guid.
955   @param[in]  TokenNumber  The PCD token number to retrieve a current value for.
968   Returns the 32-bit value for the token specified by TokenNumber and Guid.
973   @param[in]  TokenNumber  The PCD token number to retrieve a current value for.
986   This function provides a means by which to retrieve a value for a given PCD token.
988   Returns the 64-bit value for the token specified by TokenNumber and Guid.
994   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.
1007   This function provides a means by which to retrieve a value for a given PCD token.
1009   Returns the pointer to the buffer of token specified by TokenNumber and Guid.
1015   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.
1028   This function provides a means by which to retrieve a value for a given PCD token.
1030   Returns the Boolean value of the token specified by TokenNumber and Guid.
1036   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.
1049   This function provides a means by which to retrieve the size of a given PCD token.
1051   Returns the size of the token specified by TokenNumber and Guid.
1057   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.
1070   This function provides a means by which to set a value for a given PCD token.
1072   Sets the 8-bit value for the token specified by TokenNumber
1075   @param[in] TokenNumber    The PCD token number to set a current value for.
1089   This function provides a means by which to set a value for a given PCD token.
1091   Sets the 16-bit value for the token specified by TokenNumber
1094   @param[in] TokenNumber    The PCD token number to set a current value for.
1108   This function provides a means by which to set a value for a given PCD token.
1110   Sets the 32-bit value for the token specified by TokenNumber
1113   @param[in] TokenNumber    The PCD token number to set a current value for.
1127   This function provides a means by which to set a value for a given PCD token.
1129   Sets the 64-bit value for the token specified by TokenNumber
1132   @param[in] TokenNumber    The PCD token number to set a current value for.
1146   This function provides a means by which to set a value for a given PCD token.
1148   Sets a buffer for the token specified by TokenNumber to the value specified
1160   @param[in]      TokenNumber   The PCD token number to set a current value for.
1176   This function provides a means by which to set a value for a given PCD token.
1178   Sets the boolean value for the token specified by TokenNumber
1181   @param[in] TokenNumber    The PCD token number to set a current value for.
1195   This function provides a means by which to set a value for a given PCD token.
1197   Sets the 8-bit value for the token specified by TokenNumber
1204   @param[in] TokenNumber    The PCD token number to set a current value for.
1219   This function provides a means by which to set a value for a given PCD token.
1221   Sets the 16-bit value for the token specified by TokenNumber
1228   @param[in] TokenNumber    The PCD token number to set a current value for.
1243   This function provides a means by which to set a value for a given PCD token.
1245   Sets the 32-bit value for the token specified by TokenNumber
1252   @param[in] TokenNumber    The PCD token number to set a current value for.
1267   This function provides a means by which to set a value for a given PCD token.
1269   Sets the 64-bit value for the token specified by TokenNumber
1276   @param[in] TokenNumber    The PCD token number to set a current value for.
1291   This function provides a means by which to set a value for a given PCD token.
1293   Sets a buffer for the token specified by TokenNumber to the value specified by
1305   @param[in]      TokenNumber   The PCD token number to set a current value for.
1322   This function provides a means by which to set a value for a given PCD token.
1324   Sets the boolean value for the token specified by TokenNumber
1331   @param[in] TokenNumber    The PCD token number to set a current value for.
1349   PCD token has been set.
1355   @param[in]      CallBackGuid    The PCD token GUID being set.
1356   @param[in]      CallBackToken   The PCD token number being set.
1357   @param[in, out] TokenData       A pointer to the token data being set.
1371   Set up a notification function that is called when a specified token is set.
1373   When the token specified by TokenNumber and Guid is set,
1375   If Guid is NULL, then the default token space is used.
1380                                     token space is used.
1381   @param[in]  TokenNumber           The PCD token number to monitor.
1382   @param[in]  NotificationFunction  The function to call when the token
1402   @param[in]  Guid                 Specify the GUID token space.
1403   @param[in]  TokenNumber          Specify the token number.
1416   Retrieves the next token in a token space.
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,
1420   then the first token number is returned.  Otherwise, the token number that
1421   follows TokenNumber in the token space is returned.  If TokenNumber is the last
1422   token number in the token space, then 0 is returned.
1424   If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().
1427                           to set a value from.  If NULL, then the default token space is used.
1428   @param[in]  TokenNumber The previous PCD token number.  If 0, then retrieves the first PCD
1429                           token number.
1431   @return The next valid token number.
1442   Used to retrieve the list of available PCD token space GUIDs.
1444   Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces
1446   If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.
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
1451   @return The next valid token namespace.
1615   /// The null-terminated ASCII string associated with a given token. If the
1617   /// ASCII string associated with the token's namespace Guid. If NULL, there is no
1624   Retrieve additional information associated with a PCD token.
1627   human readable name that is associated with the token.
1629   If TokenNumber is not in the default token space specified, then ASSERT().
1631   @param[in]    TokenNumber The PCD token number.
1643   Retrieve additional information associated with a PCD token.
1646   human readable name that is associated with the token.
1648   If TokenNumber is not in the token space specified by Guid, then ASSERT().
1651   @param[in]    TokenNumber The PCD token number.