tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Synchronize PCD_Infrastructure 0.55 with source code. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8248 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2009-05-06 06:18:16 +00:00
parent 1f2efb0542
commit 750709525f
2 changed files with 32 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
MdePkg/Include/Ppi/Pcd.h
View File

@ -750,18 +750,24 @@ EFI_STATUS
/**
Retrieves the next valid PCD token for a given namespace.
Retrieves the next valid token number in a given namespace.
If the input token namespace or token number does not exist on the platform, an error is
returned and the value of *TokenNumber is undefined. To retrieve the "first" token,
have the pointer reference a TokenNumber value of 0.
If the input token number is 0 and there is no valid token number for this token namespace,
*TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.
If the token number is the last valid token number, *TokenNumber will be assigned to 0 and
the function return EFI_SUCCESS.
This is useful since the PCD infrastructure contains a sparse list of token numbers,
and one cannot a priori know what token numbers are valid in the database.
If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned.
If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned.
If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned.
If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned.
The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid.
If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned.
If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned.
If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned.
@param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
@param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
This is an optional parameter that may be NULL. If this parameter is NULL, then a request
is being made to retrieve tokens from the default token space.
@param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number.
@retval EFI_SUCCESS The PCD service has retrieved the next valid token number.

25
MdePkg/Include/Protocol/Pcd.h
View File

@ -759,17 +759,26 @@ EFI_STATUS
/**
Retrieves the next valid PCD token for a given namespace.
Retrieves the next valid token number in a given namespace.
This is useful since the PCD infrastructure contains a sparse list of token numbers,
and one cannot a priori know what token numbers are valid in the database.
If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned.
If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned.
If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned.
If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned.
The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid.
If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned.
If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned.
If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned.
@param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
@param[in] Guid The 128-bit unique value that designates the namespace from which to retrieve the next token.
This is an optional parameter that may be NULL. If this parameter is NULL, then a request is
being made to retrieve tokens from the default token space.
@param[in,out] TokenNumber
A pointer to the PCD token number to use to find the subsequent token number.
If the input token namespace or token number does not exist on the platform,
an error is returned and the value of *TokenNumber is undefined. To retrieve the "first" token,
have the pointer reference a TokenNumber value of 0. If the input token number is 0 and
there is no valid token number for this token namespace, *TokenNumber will be assigned to
0 and the function return EFI_SUCCESS. If the token number is the last valid token number,
*TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.
@retval EFI_SUCCESS The PCD service retrieved the next valid token number. Or the input token number
is already the last valid token number in the PCD database.