1 | @c |
---|
2 | @c COPYRIGHT (c) 1988-1998. |
---|
3 | @c On-Line Applications Research Corporation (OAR). |
---|
4 | @c All rights reserved. |
---|
5 | @c |
---|
6 | @c $Id$ |
---|
7 | @c |
---|
8 | |
---|
9 | @chapter Process Dump Control Manager |
---|
10 | |
---|
11 | @section Introduction |
---|
12 | |
---|
13 | The process dump control manager provides a portable |
---|
14 | interface for changing the path to which a process dump |
---|
15 | is written. The capabilities in this manager were defined in |
---|
16 | the POSIX 1003.1h/D3 proposed standard titled @b{Services for Reliable, |
---|
17 | Available, and Serviceable Systems}. |
---|
18 | |
---|
19 | The directives provided by the process dump control manager are: |
---|
20 | |
---|
21 | @itemize @bullet |
---|
22 | @item @code{dump_setpath} - Dump File Control |
---|
23 | @end itemize |
---|
24 | |
---|
25 | @section Background |
---|
26 | |
---|
27 | There is no background. |
---|
28 | |
---|
29 | @section Operations |
---|
30 | |
---|
31 | There is no discussion of the operations. |
---|
32 | |
---|
33 | @section Directives |
---|
34 | |
---|
35 | This section details the process dump control manager's directives. |
---|
36 | A subsection is dedicated to each of this manager's directives |
---|
37 | and describes the calling sequence, related constants, usage, |
---|
38 | and status codes. |
---|
39 | |
---|
40 | @page |
---|
41 | @subsection dump_setpath - Dump File Control |
---|
42 | |
---|
43 | @subheading CALLING SEQUENCE: |
---|
44 | |
---|
45 | @ifset is-C |
---|
46 | @example |
---|
47 | #include <dump.h> |
---|
48 | |
---|
49 | int dump_setpath( |
---|
50 | const char *path |
---|
51 | ); |
---|
52 | @end example |
---|
53 | @end ifset |
---|
54 | |
---|
55 | @ifset is-Ada |
---|
56 | @end ifset |
---|
57 | |
---|
58 | @subheading STATUS CODES: |
---|
59 | |
---|
60 | @table @b |
---|
61 | @item EACESS |
---|
62 | Search permission is denied for a component of the path prefix, |
---|
63 | or write permission is denied on the directory containing the |
---|
64 | file. |
---|
65 | |
---|
66 | @item ENAMETOOLONG |
---|
67 | The length of the argument exceeds @code{PATH_MAX} or a pathname |
---|
68 | component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC} |
---|
69 | is in effect. |
---|
70 | |
---|
71 | @item ENOENT |
---|
72 | The path argument points to an empty string. |
---|
73 | |
---|
74 | @item ENOTDIR |
---|
75 | A component of the path prefix is not a directory. |
---|
76 | |
---|
77 | @item EROFS |
---|
78 | The directory entry specified resides on a read-only file system. |
---|
79 | |
---|
80 | @end table |
---|
81 | |
---|
82 | @subheading DESCRIPTION: |
---|
83 | |
---|
84 | The @code{dump_setpath} function defines the pathname where process |
---|
85 | dumps are written. The pathname pointed to by @code{path} defines |
---|
86 | where a process dump file is written if the calling process |
---|
87 | terminates with a dump file. The @code{path} argument does not |
---|
88 | name a directory. |
---|
89 | |
---|
90 | If the @code{path} argument is NULL, the system does not write a |
---|
91 | process dump file if the calling process terminates with a dump |
---|
92 | file. If the @code{dump_setpath} function fails, the pathname for |
---|
93 | writing process dumps does not change. |
---|
94 | |
---|
95 | @subheading NOTES: |
---|
96 | |
---|
97 | The @code{_POSIX_DUMP} feature flag is defined to indicate |
---|
98 | this service is available. |
---|