mirror of https://github.com/acidanthera/audk.git
Comments synchronized with library class
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7525 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
b677694d2e
commit
c00bdbb14a
|
@ -60,11 +60,10 @@ PcdLibConstructor (
|
||||||
This function provides a means by which SKU support can be established in the PCD infrastructure.
|
This function provides a means by which SKU support can be established in the PCD infrastructure.
|
||||||
|
|
||||||
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
|
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
|
||||||
|
If SkuId >= PCD_MAX_SKU_ID, then ASSERT().
|
||||||
|
|
||||||
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
|
@param SkuId The SKU value that will be used when the PCD service retrieves and sets values
|
||||||
set values associated with a PCD token.
|
associated with a PCD token.
|
||||||
|
|
||||||
If SkuId >= 0x100, then ASSERT().
|
|
||||||
|
|
||||||
@return Return the SKU ID that just be set.
|
@return Return the SKU ID that just be set.
|
||||||
|
|
||||||
|
@ -860,7 +859,6 @@ LibPcdSetExBool (
|
||||||
When the token specified by TokenNumber and Guid is set,
|
When the token specified by TokenNumber and Guid is set,
|
||||||
then notification function specified by NotificationFunction is called.
|
then notification function specified by NotificationFunction is called.
|
||||||
If Guid is NULL, then the default token space is used.
|
If Guid is NULL, then the default token space is used.
|
||||||
|
|
||||||
If NotificationFunction is NULL, then ASSERT().
|
If NotificationFunction is NULL, then ASSERT().
|
||||||
|
|
||||||
@param[in] Guid Pointer to a 128-bit unique value that designates which
|
@param[in] Guid Pointer to a 128-bit unique value that designates which
|
||||||
|
@ -896,7 +894,6 @@ LibPcdCallbackOnSet (
|
||||||
Disable a notification function that was established with LibPcdCallbackonSet().
|
Disable a notification function that was established with LibPcdCallbackonSet().
|
||||||
|
|
||||||
Disable a notification function that was previously established with LibPcdCallbackOnSet().
|
Disable a notification function that was previously established with LibPcdCallbackOnSet().
|
||||||
|
|
||||||
If NotificationFunction is NULL, then ASSERT().
|
If NotificationFunction is NULL, then ASSERT().
|
||||||
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
|
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
|
||||||
and NotificationFunction, then ASSERT().
|
and NotificationFunction, then ASSERT().
|
||||||
|
@ -967,18 +964,12 @@ LibPcdGetNextToken (
|
||||||
/**
|
/**
|
||||||
Used to retrieve the list of available PCD token space GUIDs.
|
Used to retrieve the list of available PCD token space GUIDs.
|
||||||
|
|
||||||
Retrieves the next PCD token space from a token space specified by Guid.
|
Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces
|
||||||
Guid of NULL is reserved to mark the default local token namespace on the current
|
in the platform.
|
||||||
platform. If Guid is NULL, then the GUID of the first non-local token space of the
|
If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.
|
||||||
current platform is returned. If Guid is the last non-local token space,
|
If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.
|
||||||
then NULL is returned.
|
|
||||||
|
|
||||||
If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
|
@param TokenSpaceGuid Pointer to the a PCD token space GUID
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@param[in] Guid Pointer to a 128-bit unique value that designates from which namespace
|
|
||||||
to start the search.
|
|
||||||
|
|
||||||
@return The next valid token namespace.
|
@return The next valid token namespace.
|
||||||
|
|
||||||
|
|
|
@ -52,11 +52,10 @@ GetPcdPpiPointer (
|
||||||
This function provides a means by which SKU support can be established in the PCD infrastructure.
|
This function provides a means by which SKU support can be established in the PCD infrastructure.
|
||||||
|
|
||||||
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
|
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
|
||||||
|
If SkuId >= PCD_MAX_SKU_ID, then ASSERT().
|
||||||
|
|
||||||
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
|
@param SkuId The SKU value that will be used when the PCD service retrieves and sets values
|
||||||
set values associated with a PCD token.
|
associated with a PCD token.
|
||||||
|
|
||||||
If SkuId >= 0x100, then ASSERT().
|
|
||||||
|
|
||||||
@return Return the SKU ID that just be set.
|
@return Return the SKU ID that just be set.
|
||||||
|
|
||||||
|
@ -848,7 +847,6 @@ LibPcdSetExBool (
|
||||||
When the token specified by TokenNumber and Guid is set,
|
When the token specified by TokenNumber and Guid is set,
|
||||||
then notification function specified by NotificationFunction is called.
|
then notification function specified by NotificationFunction is called.
|
||||||
If Guid is NULL, then the default token space is used.
|
If Guid is NULL, then the default token space is used.
|
||||||
|
|
||||||
If NotificationFunction is NULL, then ASSERT().
|
If NotificationFunction is NULL, then ASSERT().
|
||||||
|
|
||||||
@param[in] Guid Pointer to a 128-bit unique value that designates which
|
@param[in] Guid Pointer to a 128-bit unique value that designates which
|
||||||
|
@ -884,7 +882,6 @@ LibPcdCallbackOnSet (
|
||||||
Disable a notification function that was established with LibPcdCallbackonSet().
|
Disable a notification function that was established with LibPcdCallbackonSet().
|
||||||
|
|
||||||
Disable a notification function that was previously established with LibPcdCallbackOnSet().
|
Disable a notification function that was previously established with LibPcdCallbackOnSet().
|
||||||
|
|
||||||
If NotificationFunction is NULL, then ASSERT().
|
If NotificationFunction is NULL, then ASSERT().
|
||||||
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
|
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
|
||||||
and NotificationFunction, then ASSERT().
|
and NotificationFunction, then ASSERT().
|
||||||
|
|
Loading…
Reference in New Issue