source: rtems/doc/new_chapters/dumpcontrol.t @ 98bdf7a

4.104.114.84.95
Last change on this file since 98bdf7a was 98bdf7a, checked in by Wade A Smith <warm38@…>, on Sep 21, 1998 at 9:34:04 PM

Updated file based upon read_lines received.

  • Property mode set to 100644
File size: 2.3 KB
Line 
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
13The process dump control manager provides a portable
14interface for changing the path to which a process dump
15is written.  The capabilities in this manager were defined in
16the POSIX 1003.1h/D3 proposed standard titled @b{Services for Reliable,
17Available, and Serviceable Systems}.
18
19The 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
27There is no background.
28
29@section Operations
30
31There is no discussion of the operations.
32
33@section Directives
34
35This section details the process dump control manager's directives.
36A subsection is dedicated to each of this manager's directives
37and describes the calling sequence, related constants, usage,
38and 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
49int 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
62Search permission is denied for a component of the path prefix,
63or write permission is denied on the directory containing the
64file.
65
66@item ENAMETOOLONG
67The length of the argument exceeds @code{PATH_MAX} or a pathname
68component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC}
69is in effect.
70
71@item ENOENT
72The path argument points to an empty string.
73
74@item ENOTDIR
75A component of the path prefix is not a directory.
76
77@item EROFS
78The directory entry specified resides on a read-only file system.
79
80@end table
81
82@subheading DESCRIPTION:
83
84The @code{dump_setpath()} function defines the pathname where process
85dumps are written.  The pathname pointed to by @code{path} defines
86where a process dump file is written if the calling process
87terminates with a dump file.  The @code{path} argument does not
88name a directory.
89
90If the @code{path} argument is NULL, the system does not write a
91process dump file if the calling process terminates with a dump
92file.  If the @code{dump_setpath} function fails, the pathname for
93writing process dumps does not change.
94
95@subheading NOTES:
96
97The @code{_POSIX_DUMP} feature flag is defined to indicate
98this service is available.
Note: See TracBrowser for help on using the repository browser.