summaryrefslogtreecommitdiff
path: root/public/fpdf_structtree.h
diff options
context:
space:
mode:
authordan sinclair <dsinclair@chromium.org>2017-04-06 14:44:02 -0400
committerChromium commit bot <commit-bot@chromium.org>2017-04-08 01:38:54 +0000
commitd9dad3a1915973d113f1f8685474a5a8c1f4faac (patch)
treebd34c61ace230963b1c7f92b30cf025cdd16f380 /public/fpdf_structtree.h
parent746c28772e01675096800d8853aae33f94ed3d55 (diff)
downloadpdfium-d9dad3a1915973d113f1f8685474a5a8c1f4faac.tar.xz
Add title (/T) extraction for PDF tagged structureschromium/3067chromium/3066
This CL adds the ability to extract the title from a tagged structure element if one exists. Bug: pdfium:672 Change-Id: I22e2a8371db4f08b8a70dd77002f1befab97f530 Reviewed-on: https://pdfium-review.googlesource.com/3819 Reviewed-by: Lei Zhang <thestig@chromium.org> Reviewed-by: Tom Sepez <tsepez@chromium.org> Commit-Queue: dsinclair <dsinclair@chromium.org>
Diffstat (limited to 'public/fpdf_structtree.h')
-rw-r--r--public/fpdf_structtree.h20
1 files changed, 20 insertions, 0 deletions
diff --git a/public/fpdf_structtree.h b/public/fpdf_structtree.h
index 6f85d4222e..9cf46cc306 100644
--- a/public/fpdf_structtree.h
+++ b/public/fpdf_structtree.h
@@ -93,6 +93,26 @@ FPDF_StructElement_GetType(FPDF_STRUCTELEMENT struct_element,
void* buffer,
unsigned long buflen);
+// Function: FPDF_StructElement_GetTitle
+// Get the title (/T) for a given element.
+// Parameters:
+// struct_element - Handle to the struct element.
+// buffer - A buffer for output. May be NULL.
+// buflen - The length of the buffer, in bytes. May be 0.
+// Return value:
+// The number of bytes in the title, including the terminating NUL
+// character. The number of bytes is returned regardless of the
+// |buffer| and |buflen| parameters.
+// Comments:
+// Regardless of the platform, the |buffer| is always in UTF-16LE
+// encoding. The string is terminated by a UTF16 NUL character. If
+// |buflen| is less than the required length, or |buffer| is NULL,
+// |buffer| will not be modified.
+DLLEXPORT unsigned long STDCALL
+FPDF_StructElement_GetTitle(FPDF_STRUCTELEMENT struct_element,
+ void* buffer,
+ unsigned long buflen);
+
// Function: FPDF_StructElement_CountChildren
// Count the number of children for the structure element.
// Parameters: