1 package FND_FILE AUTHID CURRENT_USER as
2 /* $Header: AFCPPIOS.pls 120.3 2011/08/01 19:44:57 ckclark ship $ */
3 /*#
4 * This package contains the procedures to write text to log and output files. Supports a maximum buffer line size of 32k.
5 * @rep:scope public
6 * @rep:product FND
7 * @rep:displayname FND File
8 * @rep:category BUSINESS_ENTITY FND_CP_REQUEST
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 */
12
13 LOG constant number := 1;
14 OUTPUT constant number := 2;
15
16 UTL_FILE_ERROR exception;
17
18 PRAGMA exception_init(UTL_FILE_ERROR, -20100);
19
20 /*#
21 * Writes text to a file, without appending any new line characters
22 * @param WHICH Log file or Output file
23 * @param BUFF Text to write
24 * @rep:displayname Put
25 * @rep:scope public
26 * @rep:lifecycle active
27 * @rep:compatibility S
28 */
29 procedure PUT(WHICH in number, BUFF in varchar2);
30
31 /*#
32 * Writes text to a file followed by a new line character
33 * @param WHICH Log file or Output file
34 * @param BUFF Text to write
35 * @rep:displayname Put Line
36 * @rep:scope public
37 * @rep:lifecycle active
38 * @rep:compatibility S
39 */
40 procedure PUT_LINE(WHICH in number, BUFF in varchar2);
41
42 /*#
43 * Writes line terminators to a file (new line character)
44 * @param WHICH Log file or Output file
45 * @param LINES Number of lines to write
46 * @rep:displayname Put Line
47 * @rep:scope public
48 * @rep:lifecycle active
49 * @rep:compatibility S
50 */
51 procedure NEW_LINE(WHICH in number, LINES in natural := 1);
52
53 /*#
54 * Sets the temporary log and out filenames and the temp directory to the user-specified values
55 * @param P_LOG Temporary log filename
56 * @param P_OUT Temporary output filename
57 * @param P_DIR Temporary directory name
58 * @rep:displayname Put Names
59 * @rep:scope public
60 * @rep:lifecycle active
61 * @rep:compatibility S
62 */
63 procedure PUT_NAMES(P_LOG in varchar2, P_OUT in varchar2, P_DIR in varchar2);
64
65 procedure RELEASE_NAMES(P_LOG in varchar2, P_OUT in varchar2);
66
67 procedure GET_NAMES(P_LOG in out nocopy varchar2, P_OUT in out nocopy varchar2);
68
69 /*#
70 * Closes any open log/output files
71 * @rep:displayname Close
72 * @rep:scope public
73 * @rep:lifecycle active
74 * @rep:compatibility S
75 */
76 procedure CLOSE;
77
78 /*#
79 * Returns 1 if file is open, else 0
80 * @rep:displayname Is_Open
81 * @rep:scope public
82 * @rep:lifecycle active
83 * @rep:compatibility S
84 */
85 function IS_OPEN (WHICH in varchar2) return number;
86
87 end FND_FILE;
[Home] [Help]