You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ma...@apache.org on 2021/02/28 15:08:39 UTC
svn commit: r1886998 -
/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java
Author: mariusvolkhart
Date: Sun Feb 28 15:08:39 2021
New Revision: 1886998
URL: http://svn.apache.org/viewvc?rev=1886998&view=rev
Log:
Add documentation for HWPF FileInformationBlock DggInfo methods
This documentation comes from [MS-DOC] - v20191119.
Modified:
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java?rev=1886998&r1=1886997&r2=1886998&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java Sun Feb 28 15:08:39 2021
@@ -1004,11 +1004,21 @@ public final class FileInformationBlock
return _fieldHandler.getFieldSize(FIBFieldHandler.PLCSPAMOM);
}
+ /**
+ * @return Offset in the Table Stream at which the {@link EscherRecordHolder} exists.
+ */
public int getFcDggInfo()
{
return _fieldHandler.getFieldOffset(FIBFieldHandler.DGGINFO);
}
+ /**
+ * Returns the size, in bytes, of the {@link EscherRecordHolder} at the offset {@link #getFcDggInfo()}.
+ * <p>
+ * If {@code 0}, there MUST NOT be any drawings in the document.
+ *
+ * @return Size, in bytes, of the {@link EscherRecordHolder} at the offset {@link #getFcDggInfo()}.
+ */
public int getLcbDggInfo()
{
return _fieldHandler.getFieldSize(FIBFieldHandler.DGGINFO);
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org