Merge to XFA: Implement FPDFAction_GetFilePath().

public/fpdf_doc.h

 // Copyright 2014 PDFium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
 
 #ifndef PUBLIC_FPDF_DOC_H_
 #define PUBLIC_FPDF_DOC_H_
 
 #include "fpdfview.h"
@@ skipping 92 matching lines @@
 // Return value:
 //          Handle to the action data. NULL if no action is associated with this
 //          bookmark. In this case, the
 //          application should try FPDFBookmark_GetDest.
 //
 DLLEXPORT FPDF_ACTION STDCALL FPDFBookmark_GetAction(FPDF_BOOKMARK bookmark);
 
 #define PDFACTION_UNSUPPORTED 0  // Unsupported action type.
 #define PDFACTION_GOTO 1         // Go to a destination within current document.
 #define PDFACTION_REMOTEGOTO 2   // Go to a destination within another document.
-#define PDFACTION_URI \
-  3  // Universal Resource Identifier, including web pages and
-     // other Internet based resources.
-#define PDFACTION_LAUNCH 4  // Launch an application or open a file.
+#define PDFACTION_URI 3          // Universal Resource Identifier, including web
+                                 // pages and other Internet based resources.
+#define PDFACTION_LAUNCH 4       // Launch an application or open a file.
 
 // Function: FPDFAction_GetType
 //          Get type of an action.
 // Parameters:
 //          action      -   Handle to the action.
 // Return value:
 //          A type number as defined above.
 //
 DLLEXPORT unsigned long STDCALL FPDFAction_GetType(FPDF_ACTION action);
 
 // Function: FPDFAction_GetDest
 //          Get destination of an action.
 // Parameters:
 //          document    -   Handle to the document.
 //          action      -   Handle to the action. It must be a GOTO or
 //          REMOTEGOTO action.
 // Return value:
 //          Handle to the destination data.
 // Comments:
 //          In case of remote goto action, the application should first use
 //          FPDFAction_GetFilePath to
 //          get file path, then load that particular document, and use its
 //          document handle to call this
 //          function.
 //
 DLLEXPORT FPDF_DEST STDCALL FPDFAction_GetDest(FPDF_DOCUMENT document,
                                                FPDF_ACTION action);
 
+// Function: FPDFAction_GetFilePath
+//          Get file path of a remote goto action.
+// Parameters:
+//          action    -   Handle to the action. Must be a REMOTEGOTO or
+//                        LAUNCH action.
+//          buffer    -   A buffer for output the path string. Can be NULL.
+//          buflen    -   The length of the buffer, number of bytes. Can be 0.
+// Return value:
+//          Number of bytes the file path consumes, including trailing zero.
+//
+// Comments:
+//          The file path is UTF-8 encoded. The return value is the number of
+//          bytes required for the buffer, even when there is no buffer
+//          specified, or the buffer size is less then required. In this case,
+//          the buffer will not be modified.
+//
+DLLEXPORT unsigned long STDCALL
+FPDFAction_GetFilePath(FPDF_ACTION action, void* buffer, unsigned long buflen);
+
 // Function: FPDFAction_GetURIPath
 //          Get URI path of a URI action.
 // Parameters:
 //          document    -   Handle to the document.
 //          action      -   Handle to the action. Must be a URI action.
 //          buffer      -   A buffer for output the path string. Can be NULL.
 //          buflen      -   The length of the buffer, number of bytes. Can be 0.
 // Return value:
 //          Number of bytes the URI path consumes, including trailing zeros.
 // Comments:
 //          The URI path is always encoded in 7-bit ASCII.
 //
-//          The return value always indicated number of bytes required for the
-//          buffer, even when there is
-//          no buffer specified, or the buffer size is less then required. In
-//          this case, the buffer will not
-//          be modified.
+//          The return value is the number of bytes required for the buffer,
+//          even when there is no buffer specified, or the buffer size is less
+//          then required. In this case, the buffer will not be modified.
 //
 DLLEXPORT unsigned long STDCALL FPDFAction_GetURIPath(FPDF_DOCUMENT document,
                                                       FPDF_ACTION action,
                                                       void* buffer,
                                                       unsigned long buflen);
 
 // Function: FPDFDest_GetPageIndex
 //          Get page index of a destination.
 // Parameters:
 //          document    -   Handle to the document.
@@ skipping 180 matching lines @@
 DLLEXPORT unsigned long STDCALL FPDF_GetMetaText(FPDF_DOCUMENT doc,
                                                  FPDF_BYTESTRING tag,
                                                  void* buffer,
                                                  unsigned long buflen);
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif  // PUBLIC_FPDF_DOC_H_