OLD | NEW |
1 // Copyright 2014 PDFium Authors. All rights reserved. | 1 // Copyright 2014 PDFium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com | 5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com |
6 | 6 |
7 #ifndef PUBLIC_FPDF_DOC_H_ | 7 #ifndef PUBLIC_FPDF_DOC_H_ |
8 #define PUBLIC_FPDF_DOC_H_ | 8 #define PUBLIC_FPDF_DOC_H_ |
9 | 9 |
10 // NOLINTNEXTLINE(build/include) | 10 // NOLINTNEXTLINE(build/include) |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
61 // | 61 // |
62 // bookmark - handle to the bookmark. | 62 // bookmark - handle to the bookmark. |
63 // buffer - buffer for the title. May be NULL. | 63 // buffer - buffer for the title. May be NULL. |
64 // buflen - the length of the buffer in bytes. May be 0. | 64 // buflen - the length of the buffer in bytes. May be 0. |
65 // | 65 // |
66 // Returns the number of bytes in the title, including the terminating NUL | 66 // Returns the number of bytes in the title, including the terminating NUL |
67 // character. The number of bytes is returned regardless of the |buffer| and | 67 // character. The number of bytes is returned regardless of the |buffer| and |
68 // |buflen| parameters. | 68 // |buflen| parameters. |
69 // | 69 // |
70 // Regardless of the platform, the |buffer| is always in UTF-16LE encoding. The | 70 // Regardless of the platform, the |buffer| is always in UTF-16LE encoding. The |
71 // string is terminated by a UTF16 NUL character. If |buflen| is less then the | 71 // string is terminated by a UTF16 NUL character. If |buflen| is less than the |
72 // required length, or |buffer| is NULL, |buffer| will not be modified. | 72 // required length, or |buffer| is NULL, |buffer| will not be modified. |
73 DLLEXPORT unsigned long STDCALL FPDFBookmark_GetTitle(FPDF_BOOKMARK bookmark, | 73 DLLEXPORT unsigned long STDCALL FPDFBookmark_GetTitle(FPDF_BOOKMARK bookmark, |
74 void* buffer, | 74 void* buffer, |
75 unsigned long buflen); | 75 unsigned long buflen); |
76 | 76 |
77 // Find the bookmark with |title| in |document|. | 77 // Find the bookmark with |title| in |document|. |
78 // | 78 // |
79 // document - handle to the document. | 79 // document - handle to the document. |
80 // title - the UTF-16LE encoded Unicode title for which to search. | 80 // title - the UTF-16LE encoded Unicode title for which to search. |
81 // | 81 // |
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
135 // | 135 // |
136 // action - handle to the action. |action| must be a |PDFACTION_LAUNCH| or | 136 // action - handle to the action. |action| must be a |PDFACTION_LAUNCH| or |
137 // |PDFACTION_REMOTEGOTO| | 137 // |PDFACTION_REMOTEGOTO| |
138 // buffer - a buffer for output the path string. May be NULL. | 138 // buffer - a buffer for output the path string. May be NULL. |
139 // buflen - the length of the buffer, in bytes. May be 0. | 139 // buflen - the length of the buffer, in bytes. May be 0. |
140 // | 140 // |
141 // Returns the number of bytes in the file path, including the trailing UTF16 | 141 // Returns the number of bytes in the file path, including the trailing UTF16 |
142 // NUL character. | 142 // NUL character. |
143 // | 143 // |
144 // Regardless of the platform, the |buffer| is always in UTF-16LE encoding. | 144 // Regardless of the platform, the |buffer| is always in UTF-16LE encoding. |
145 // If |buflen| is less then the returned length, or |buffer| is NULL, |buffer| | 145 // If |buflen| is less than the returned length, or |buffer| is NULL, |buffer| |
146 // will not be modified. | 146 // will not be modified. |
147 DLLEXPORT unsigned long STDCALL | 147 DLLEXPORT unsigned long STDCALL |
148 FPDFAction_GetFilePath(FPDF_ACTION action, void* buffer, unsigned long buflen); | 148 FPDFAction_GetFilePath(FPDF_ACTION action, void* buffer, unsigned long buflen); |
149 | 149 |
150 // Get the URI path of a |PDFACTION_URI| |action|. | 150 // Get the URI path of a |PDFACTION_URI| |action|. |
151 // | 151 // |
152 // document - handle to the document. | 152 // document - handle to the document. |
153 // action - handle to the action. Must be a |PDFACTION_URI|. | 153 // action - handle to the action. Must be a |PDFACTION_URI|. |
154 // buffer - a buffer for the path string. May be NULL. | 154 // buffer - a buffer for the path string. May be NULL. |
155 // buflen - the length of the buffer, in bytes. May be 0. | 155 // buflen - the length of the buffer, in bytes. May be 0. |
156 // | 156 // |
157 // Returns the number of bytes in the URI path, including trailing zeros. | 157 // Returns the number of bytes in the URI path, including trailing zeros. |
158 // | 158 // |
159 // The |buffer| is always encoded in 7-bit ASCII. If |buflen| is less then the | 159 // The |buffer| is always encoded in 7-bit ASCII. If |buflen| is less than the |
160 // returned length, or |buffer| is NULL, |buffer| will not be modified. | 160 // returned length, or |buffer| is NULL, |buffer| will not be modified. |
161 DLLEXPORT unsigned long STDCALL FPDFAction_GetURIPath(FPDF_DOCUMENT document, | 161 DLLEXPORT unsigned long STDCALL FPDFAction_GetURIPath(FPDF_DOCUMENT document, |
162 FPDF_ACTION action, | 162 FPDF_ACTION action, |
163 void* buffer, | 163 void* buffer, |
164 unsigned long buflen); | 164 unsigned long buflen); |
165 | 165 |
166 // Get the page index of |dest|. | 166 // Get the page index of |dest|. |
167 // | 167 // |
168 // document - handle to the document. | 168 // document - handle to the document. |
169 // dest - handle to the destination. | 169 // dest - handle to the destination. |
(...skipping 146 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
316 DLLEXPORT unsigned long STDCALL FPDF_GetPagelLabel(FPDF_DOCUMENT document, | 316 DLLEXPORT unsigned long STDCALL FPDF_GetPagelLabel(FPDF_DOCUMENT document, |
317 int page_index, | 317 int page_index, |
318 void* buffer, | 318 void* buffer, |
319 unsigned long buflen); | 319 unsigned long buflen); |
320 | 320 |
321 #ifdef __cplusplus | 321 #ifdef __cplusplus |
322 } // extern "C" | 322 } // extern "C" |
323 #endif // __cplusplus | 323 #endif // __cplusplus |
324 | 324 |
325 #endif // PUBLIC_FPDF_DOC_H_ | 325 #endif // PUBLIC_FPDF_DOC_H_ |
OLD | NEW |