MdeModulePkg/UdfDxe: Update GetInfo() for FS VolumeLabel info request

[mirror_edk2.git] / MdeModulePkg / Universal / Disk / UdfDxe / Udf.h

diff --git a/MdeModulePkg/Universal/Disk/UdfDxe/Udf.h b/MdeModulePkg/Universal/Disk/UdfDxe/Udf.h
index b054c623e5a56683a76e3fd2f632e5454c1a020f..a8a3bed62c22adc7c7d4e5e7b2e79a4a62bde56d 100644 (file)
--- a/MdeModulePkg/Universal/Disk/UdfDxe/Udf.h
+++ b/MdeModulePkg/Universal/Disk/UdfDxe/Udf.h
@@ -900,6 +900,33 @@ SetFileInfo (
   OUT     VOID           *Buffer\r
   );\r
 \r
+/**\r
+  Get volume label of an UDF volume.\r
+\r
+  @attention This is boundary function that may receive untrusted input.\r
+  @attention The input is from FileSystem.\r
+\r
+  The File Set Descriptor is external input, so this routine will do basic\r
+  validation for File Set Descriptor and report status.\r
+\r
+  @param[in]   Volume   Volume information pointer.\r
+  @param[in]   CharMax  The maximum number of Unicode char in String,\r
+                        including terminating null char.\r
+  @param[out]  String   String buffer pointer to store the volume label.\r
+\r
+  @retval EFI_SUCCESS           Volume label is returned.\r
+  @retval EFI_VOLUME_CORRUPTED  The file system structures are corrupted.\r
+  @retval EFI_BUFFER_TOO_SMALL  The string buffer String cannot hold the\r
+                                volume label.\r
+\r
+**/\r
+EFI_STATUS\r
+GetVolumeLabel (\r
+  IN   UDF_VOLUME_INFO  *Volume,\r
+  IN   UINTN            CharMax,\r
+  OUT  CHAR16           *String\r
+  );\r
+\r
 /**\r
   Get volume and free space size information of an UDF volume.\r
 \r