diff options
| author | Eric Dong <eric.dong@intel.com> | 2013-10-12 02:10:02 +0000 |
|---|---|---|
| committer | ydong10 <ydong10@6f19259b-4bc3-4df7-8a09-765794883524> | 2013-10-12 02:10:02 +0000 |
| commit | 09acdc0b24ac50f8623609d67ccc52a785b4fe57 (patch) | |
| tree | 6330d4d91ababd09583b736ccba26215630721c1 /MdeModulePkg | |
| parent | 59b1b9d20a8726ba165bad000b5d1f3f9c8ed32b (diff) | |
Update comments for VarOffset field in the dynamic create question function.
Signed-off-by: Eric Dong <eric.dong@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14765 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg')
| -rw-r--r-- | MdeModulePkg/Include/Library/HiiLib.h | 21 | ||||
| -rw-r--r-- | MdeModulePkg/Library/UefiHiiLib/HiiLib.c | 21 |
2 files changed, 28 insertions, 14 deletions
diff --git a/MdeModulePkg/Include/Library/HiiLib.h b/MdeModulePkg/Include/Library/HiiLib.h index 1bdcbfe56..0e323df22 100644 --- a/MdeModulePkg/Include/Library/HiiLib.h +++ b/MdeModulePkg/Include/Library/HiiLib.h @@ -732,7 +732,8 @@ HiiCreateGotoExOpCode ( @param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
- @param[in] VarOffset The offset in Storage.
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@@ -768,7 +769,8 @@ HiiCreateCheckBoxOpCode ( @param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
- @param[in] VarOffset The offset in Storage.
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@@ -810,7 +812,8 @@ HiiCreateNumericOpCode ( @param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
- @param[in] VarOffset The offset in Storage.
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@@ -850,7 +853,8 @@ HiiCreateStringOpCode ( @param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
- @param[in] VarOffset The offset in Storage.
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@@ -888,7 +892,8 @@ HiiCreateOneOfOpCode ( @param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] QuestionId The question ID.
@param[in] VarStoreId The storage ID.
- @param[in] VarOffset The offset in Storage.
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt The string ID for Prompt.
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header.
@@ -954,7 +959,8 @@ HiiCreateTextOpCode ( @param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID, optional. If DateFlags is not
QF_DATE_STORAGE_NORMAL, this parameter is ignored.
- @param[in] VarOffset Offset in Storage, optional. If DateFlags is not
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair, optional. If DateFlags is not
QF_DATE_STORAGE_NORMAL, this parameter is ignored.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@@ -992,7 +998,8 @@ HiiCreateDateOpCode ( @param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID, optional. If TimeFlags is not
QF_TIME_STORAGE_NORMAL, this parameter is ignored.
- @param[in] VarOffset Offset in Storage, optional. If TimeFlags is not
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair, optional. If TimeFlags is not
QF_TIME_STORAGE_NORMAL, this parameter is ignored.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
diff --git a/MdeModulePkg/Library/UefiHiiLib/HiiLib.c b/MdeModulePkg/Library/UefiHiiLib/HiiLib.c index f48f42fcd..09f1ff754 100644 --- a/MdeModulePkg/Library/UefiHiiLib/HiiLib.c +++ b/MdeModulePkg/Library/UefiHiiLib/HiiLib.c @@ -3284,7 +3284,8 @@ HiiCreateGotoExOpCode ( @param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
- @param[in] VarOffset Offset in Storage
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@@ -3345,7 +3346,8 @@ HiiCreateCheckBoxOpCode ( @param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
- @param[in] VarOffset Offset in Storage
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@@ -3446,7 +3448,8 @@ HiiCreateNumericOpCode ( @param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
- @param[in] VarOffset Offset in Storage
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@@ -3513,7 +3516,8 @@ HiiCreateStringOpCode ( @param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
- @param[in] VarOffset Offset in Storage
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@@ -3580,7 +3584,8 @@ HiiCreateOneOfOpCode ( @param[in] OpCodeHandle Handle to the buffer of opcodes.
@param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID
- @param[in] VarOffset Offset in Storage
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@param[in] QuestionFlags Flags in Question Header
@@ -3682,7 +3687,8 @@ HiiCreateTextOpCode ( @param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID, optional. If DateFlags is not
QF_DATE_STORAGE_NORMAL, this parameter is ignored.
- @param[in] VarOffset Offset in Storage, optional. If DateFlags is not
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair, optional. If DateFlags is not
QF_DATE_STORAGE_NORMAL, this parameter is ignored.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
@@ -3746,7 +3752,8 @@ HiiCreateDateOpCode ( @param[in] QuestionId Question ID
@param[in] VarStoreId Storage ID, optional. If TimeFlags is not
QF_TIME_STORAGE_NORMAL, this parameter is ignored.
- @param[in] VarOffset Offset in Storage, optional. If TimeFlags is not
+ @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
+ for this name/value pair, optional. If TimeFlags is not
QF_TIME_STORAGE_NORMAL, this parameter is ignored.
@param[in] Prompt String ID for Prompt
@param[in] Help String ID for Help
|