ZipEntry.Comment Property

Definition

Returns the comment string for the entry. -or- Sets the optional comment string for the entry.

public virtual string? Comment { [Android.Runtime.Register("getComment", "()Ljava/lang/String;", "GetGetCommentHandler")] get; [Android.Runtime.Register("setComment", "(Ljava/lang/String;)V", "GetSetComment_Ljava_lang_String_Handler")] set; }
[<get: Android.Runtime.Register("getComment", "()Ljava/lang/String;", "GetGetCommentHandler")>]
[<set: Android.Runtime.Register("setComment", "(Ljava/lang/String;)V", "GetSetComment_Ljava_lang_String_Handler")>]
member this.Comment : string with get, set

Property Value

the comment string for the entry, or null if none

Attributes

Exceptions

if the comment is >= 64 Ki UTF-8 bytes.

Remarks

Property getter documentation:

Returns the comment string for the entry.

Java documentation for java.util.zip.ZipEntry.getComment().

Property setter documentation:

Sets the optional comment string for the entry.

ZIP entry comments have maximum length of 0xffff. If the length of the specified comment string is greater than 0xFFFF bytes after encoding, only the first 0xFFFF bytes are output to the ZIP file entry.

Java documentation for java.util.zip.ZipEntry.setComment(java.lang.String).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to