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 // NOTE: External docs refer to this file as "fpdfview.h", so do not rename | 7 // NOTE: External docs refer to this file as "fpdfview.h", so do not rename |
8 // despite lack of consitency with other public files. | 8 // despite lack of consitency with other public files. |
9 | 9 |
10 #ifndef _FPDFVIEW_H_ | 10 #ifndef _FPDFVIEW_H_ |
(...skipping 720 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
731 DLLEXPORT FPDF_DWORD STDCALL FPDF_CountNamedDests(FPDF_DOCUMENT document); | 731 DLLEXPORT FPDF_DWORD STDCALL FPDF_CountNamedDests(FPDF_DOCUMENT document); |
732 | 732 |
733 // Function: FPDF_GetNamedDestByName | 733 // Function: FPDF_GetNamedDestByName |
734 // get a special dest handle by the index. | 734 // get a special dest handle by the index. |
735 // Parameters: | 735 // Parameters: |
736 // document - Handle to the loaded document. | 736 // document - Handle to the loaded document. |
737 // name - The name of a special named dest
. | 737 // name - The name of a special named dest
. |
738 // Return value: | 738 // Return value: |
739 // The handle of the dest. | 739 // The handle of the dest. |
740 // | 740 // |
741 DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDestByName(FPDF_DOCUMENT document,FPDF_
BYTESTRING name); | 741 DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDestByName(FPDF_DOCUMENT document, FPDF
_BYTESTRING name); |
742 | 742 |
743 // Function: FPDF_GetNamedDest | 743 // Function: FPDF_GetNamedDest |
744 // Get the specified named destinations of the PDF document
by index. | 744 // Get the specified named destinations of the PDF document
by index. |
745 // Parameters: | 745 // Parameters: |
746 // document - Handle to a document | 746 // document - Handle to a document |
747 // index - The index of named destination. | 747 // index - The index of named destination. |
748 // buffer - The buffer to obtain destination
name, used as wchar_t*. | 748 // buffer - The buffer to obtain destination
name, used as wchar_t*. |
749 // buflen [in/out] - Size of the buffer in bytes on i
nput, length of the result in bytes on output or -1 if the buffer is too small. | 749 // buflen [in/out] - Size of the buffer in bytes on i
nput, length of the result in bytes on output or -1 if the buffer is too small. |
750 // Return value: | 750 // Return value: |
751 // The destination handle of a named destination, or NULL i
f no named destination corresponding to |index|. | 751 // The destination handle of a named destination, or NULL i
f no named destination corresponding to |index|. |
752 // Comments: | 752 // Comments: |
753 // Call this function twice to get the name of the named de
stination: | 753 // Call this function twice to get the name of the named de
stination: |
754 // 1) First time pass in |buffer| as NULL and get buflen. | 754 // 1) First time pass in |buffer| as NULL and get buflen. |
755 // 2) Second time pass in allocated |buffer| and buflen to
retrieve |buffer|, which should be used as wchar_t*. | 755 // 2) Second time pass in allocated |buffer| and buflen to
retrieve |buffer|, which should be used as wchar_t*. |
756 // If buflen is not sufficiently large, it will be set t
o -1 upon return. | 756 // If buflen is not sufficiently large, it will be set t
o -1 upon return. |
757 // | 757 // |
758 DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDest(FPDF_DOCUMENT document, int index,
void* buffer, long& buflen); | 758 DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDest(FPDF_DOCUMENT document, int index,
void* buffer, long* buflen); |
759 | 759 |
760 // Function: FPDF_BStr_Init | 760 // Function: FPDF_BStr_Init |
761 // Helper function to initialize a byte string. | 761 // Helper function to initialize a byte string. |
762 DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Init(FPDF_BSTR* str); | 762 DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Init(FPDF_BSTR* str); |
763 | 763 |
764 // Function: FPDF_BStr_Set | 764 // Function: FPDF_BStr_Set |
765 // Helper function to set string data. | 765 // Helper function to set string data. |
766 DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Set(FPDF_BSTR* str, FPDF_LPCSTR bstr, in
t length); | 766 DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Set(FPDF_BSTR* str, FPDF_LPCSTR bstr, in
t length); |
767 | 767 |
768 // Function: FPDF_BStr_Clear | 768 // Function: FPDF_BStr_Clear |
769 // Helper function to clear a byte string. | 769 // Helper function to clear a byte string. |
770 DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Clear(FPDF_BSTR* str); | 770 DLLEXPORT FPDF_RESULT STDCALL FPDF_BStr_Clear(FPDF_BSTR* str); |
771 | 771 |
772 #ifdef __cplusplus | 772 #ifdef __cplusplus |
773 }; | 773 }; |
774 #endif | 774 #endif |
775 | 775 |
776 #endif // _FPDFVIEW_H_ | 776 #endif // _FPDFVIEW_H_ |
OLD | NEW |