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

diff --git a/MdeModulePkg/Include/Library/HiiLib.h b/MdeModulePkg/Include/Library/HiiLib.h
index 1bdcbfe5627ac3c1b829cfa92c50451e54534cf2..0e323df221cb5fbf0155cfbece094ee742c0c74b 100644 (file)
--- 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.\r
   @param[in]  QuestionId            The question ID.\r
   @param[in]  VarStoreId            The storage ID.\r
-  @param[in]  VarOffset             The offset in Storage.\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                The string ID for Prompt.\r
   @param[in]  Help                  The string ID for Help.\r
   @param[in]  QuestionFlags         The flags in Question Header.\r
@@ -768,7 +769,8 @@ HiiCreateCheckBoxOpCode (
   @param[in]  OpCodeHandle          The handle to the buffer of opcodes.\r
   @param[in]  QuestionId            The question ID.\r
   @param[in]  VarStoreId            The storage ID.\r
-  @param[in]  VarOffset             The offset in Storage.\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                The string ID for Prompt.\r
   @param[in]  Help                  The string ID for Help.\r
   @param[in]  QuestionFlags         The flags in Question Header.\r
@@ -810,7 +812,8 @@ HiiCreateNumericOpCode (
   @param[in]  OpCodeHandle          The handle to the buffer of opcodes.\r
   @param[in]  QuestionId            The question ID.\r
   @param[in]  VarStoreId            The storage ID.\r
-  @param[in]  VarOffset             The offset in Storage.\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                The string ID for Prompt.\r
   @param[in]  Help                  The string ID for Help.\r
   @param[in]  QuestionFlags         The flags in Question Header.\r
@@ -850,7 +853,8 @@ HiiCreateStringOpCode (
   @param[in]  OpCodeHandle          The handle to the buffer of opcodes.\r
   @param[in]  QuestionId            The question ID.\r
   @param[in]  VarStoreId            The storage ID.\r
-  @param[in]  VarOffset             The offset in Storage.\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                The string ID for Prompt.\r
   @param[in]  Help                  The string ID for Help.\r
   @param[in]  QuestionFlags         The flags in Question Header.\r
@@ -888,7 +892,8 @@ HiiCreateOneOfOpCode (
   @param[in]  OpCodeHandle          The handle to the buffer of opcodes.\r
   @param[in]  QuestionId            The question ID.\r
   @param[in]  VarStoreId            The storage ID.\r
-  @param[in]  VarOffset             The offset in Storage.\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                The string ID for Prompt.\r
   @param[in]  Help                  The string ID for Help.\r
   @param[in]  QuestionFlags         The flags in Question Header.\r
@@ -954,7 +959,8 @@ HiiCreateTextOpCode (
   @param[in]  QuestionId            Question ID\r
   @param[in]  VarStoreId            Storage ID, optional. If DateFlags is not\r
                                     QF_DATE_STORAGE_NORMAL, this parameter is ignored.\r
-  @param[in]  VarOffset             Offset in Storage, optional. If DateFlags is not\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair, optional. If DateFlags is not\r
                                     QF_DATE_STORAGE_NORMAL, this parameter is ignored.\r
   @param[in]  Prompt                String ID for Prompt\r
   @param[in]  Help                  String ID for Help\r
@@ -992,7 +998,8 @@ HiiCreateDateOpCode (
   @param[in]  QuestionId            Question ID\r
   @param[in]  VarStoreId            Storage ID, optional. If TimeFlags is not\r
                                     QF_TIME_STORAGE_NORMAL, this parameter is ignored.\r
-  @param[in]  VarOffset             Offset in Storage, optional. If TimeFlags is not\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair, optional. If TimeFlags is not\r
                                     QF_TIME_STORAGE_NORMAL, this parameter is ignored.\r
   @param[in]  Prompt                String ID for Prompt\r
   @param[in]  Help                  String ID for Help\r

diff --git a/MdeModulePkg/Library/UefiHiiLib/HiiLib.c b/MdeModulePkg/Library/UefiHiiLib/HiiLib.c
index f48f42fcdb0050ec0410c27af77ff6f9554af89b..09f1ff7545237a4ac76ef8cd998e5bf266c9293b 100644 (file)
--- 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.\r
   @param[in]  QuestionId            Question ID\r
   @param[in]  VarStoreId            Storage ID\r
-  @param[in]  VarOffset             Offset in Storage\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                String ID for Prompt\r
   @param[in]  Help                  String ID for Help\r
   @param[in]  QuestionFlags         Flags in Question Header\r
@@ -3345,7 +3346,8 @@ HiiCreateCheckBoxOpCode (
   @param[in]  OpCodeHandle          Handle to the buffer of opcodes.\r
   @param[in]  QuestionId            Question ID\r
   @param[in]  VarStoreId            Storage ID\r
-  @param[in]  VarOffset             Offset in Storage\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                String ID for Prompt\r
   @param[in]  Help                  String ID for Help\r
   @param[in]  QuestionFlags         Flags in Question Header\r
@@ -3446,7 +3448,8 @@ HiiCreateNumericOpCode (
   @param[in]  OpCodeHandle          Handle to the buffer of opcodes.\r
   @param[in]  QuestionId            Question ID\r
   @param[in]  VarStoreId            Storage ID\r
-  @param[in]  VarOffset             Offset in Storage\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                String ID for Prompt\r
   @param[in]  Help                  String ID for Help\r
   @param[in]  QuestionFlags         Flags in Question Header\r
@@ -3513,7 +3516,8 @@ HiiCreateStringOpCode (
   @param[in]  OpCodeHandle          Handle to the buffer of opcodes.\r
   @param[in]  QuestionId            Question ID\r
   @param[in]  VarStoreId            Storage ID\r
-  @param[in]  VarOffset             Offset in Storage\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                String ID for Prompt\r
   @param[in]  Help                  String ID for Help\r
   @param[in]  QuestionFlags         Flags in Question Header\r
@@ -3580,7 +3584,8 @@ HiiCreateOneOfOpCode (
   @param[in]  OpCodeHandle          Handle to the buffer of opcodes.\r
   @param[in]  QuestionId            Question ID\r
   @param[in]  VarStoreId            Storage ID\r
-  @param[in]  VarOffset             Offset in Storage\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair.\r
   @param[in]  Prompt                String ID for Prompt\r
   @param[in]  Help                  String ID for Help\r
   @param[in]  QuestionFlags         Flags in Question Header\r
@@ -3682,7 +3687,8 @@ HiiCreateTextOpCode (
   @param[in]  QuestionId            Question ID\r
   @param[in]  VarStoreId            Storage ID, optional. If DateFlags is not\r
                                     QF_DATE_STORAGE_NORMAL, this parameter is ignored.\r
-  @param[in]  VarOffset             Offset in Storage, optional. If DateFlags is not\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair, optional. If DateFlags is not\r
                                     QF_DATE_STORAGE_NORMAL, this parameter is ignored.\r
   @param[in]  Prompt                String ID for Prompt\r
   @param[in]  Help                  String ID for Help\r
@@ -3746,7 +3752,8 @@ HiiCreateDateOpCode (
   @param[in]  QuestionId            Question ID\r
   @param[in]  VarStoreId            Storage ID, optional. If TimeFlags is not\r
                                     QF_TIME_STORAGE_NORMAL, this parameter is ignored.\r
-  @param[in]  VarOffset             Offset in Storage, optional. If TimeFlags is not\r
+  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)\r
+                                    for this name/value pair, optional. If TimeFlags is not\r
                                     QF_TIME_STORAGE_NORMAL, this parameter is ignored.\r
   @param[in]  Prompt                String ID for Prompt\r
   @param[in]  Help                  String ID for Help\r