summaryrefslogtreecommitdiffstats
path: root/MdePkg/Include/Protocol/IScsiInitiatorName.h
diff options
context:
space:
mode:
authorlzeng14 <lzeng14@6f19259b-4bc3-4df7-8a09-765794883524>2011-06-08 05:53:18 +0000
committerlzeng14 <lzeng14@6f19259b-4bc3-4df7-8a09-765794883524>2011-06-08 05:53:18 +0000
commit4f0779023cb4f633425a6fa8df747326336f2077 (patch)
treeb4b886d425bb25ddd135777f46264f493b9a841e /MdePkg/Include/Protocol/IScsiInitiatorName.h
parent8052c4a2b9e0c3575e912e5867cd0d7c2669c925 (diff)
downloadedk2-4f0779023cb4f633425a6fa8df747326336f2077.tar.gz
edk2-4f0779023cb4f633425a6fa8df747326336f2077.tar.bz2
edk2-4f0779023cb4f633425a6fa8df747326336f2077.zip
String Reference Cleanup.
Signed-off-by: lzeng14 Reviewed-by: lgao4 git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11762 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/IScsiInitiatorName.h')
-rw-r--r--MdePkg/Include/Protocol/IScsiInitiatorName.h14
1 files changed, 5 insertions, 9 deletions
diff --git a/MdePkg/Include/Protocol/IScsiInitiatorName.h b/MdePkg/Include/Protocol/IScsiInitiatorName.h
index f7b890e2a6..e55c51b7c6 100644
--- a/MdePkg/Include/Protocol/IScsiInitiatorName.h
+++ b/MdePkg/Include/Protocol/IScsiInitiatorName.h
@@ -2,7 +2,7 @@
EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0.
It provides the ability to get and set the iSCSI Initiator Name.
- Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -29,7 +29,8 @@ typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTO
@param This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
@param BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the
variable data buffer.
- @param Buffer Pointer to the buffer for data to be read.
+ @param Buffer Pointer to the buffer for data to be read. The data is a null-terminated UTF-8 encoded string.
+ The maximum length is 223 characters, including the null-terminator.
@retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the
BufferSize was sufficient to handle the iSCSI initiator name
@@ -53,7 +54,8 @@ EFI_STATUS
@param This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
@param BufferSize Size of the buffer in bytes pointed to by Buffer.
- @param Buffer Pointer to the buffer for data to be written.
+ @param Buffer Pointer to the buffer for data to be written. The data is a null-terminated UTF-8 encoded string.
+ The maximum length is 223 characters, including the null-terminator.
@retval EFI_SUCCESS Data was successfully stored by the protocol.
@retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.
@@ -83,9 +85,3 @@ extern EFI_GUID gEfiIScsiInitiatorNameProtocolGuid;
#endif
-
-
-
-
-
-