summaryrefslogtreecommitdiffstats
path: root/doc/new_chapters/dumpcontrol.t
blob: d196251cb437e7502d105d766a69bd2c3bd72f7b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
@c
@c  COPYRIGHT (c) 1988-1998.
@c  On-Line Applications Research Corporation (OAR).
@c  All rights reserved. 
@c
@c  $Id$
@c

@chapter Process Dump Control Manager

@section Introduction

The 
process dump control manager is ...

The directives provided by the process dump control manager are:

@itemize @bullet
@item @code{dump_setpath} - Dump File Control 
@end itemize

@section Background

@section Operations

@section Directives

This section details the process dump control manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.

@page
@subsection dump_setpath - Dump File Control

@subheading CALLING SEQUENCE:

@ifset is-C
@example
int dump_setpath(
  const char      *path
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@table @b
@item EACESS
Search permission is denied for a component of the path prefix,
or write permission is denied on the directory containing the 
file.
@item ENAMETOOLONG
The length of the argument exceeds {PATH_MAX} or a pathname
component is longer than {NAME_MAX} while {_POSIX_NO_TRUNC}
is in effect.
@item ENOENT
The path argument points to an empty string.
@item ENOSYS
The function dump_setpath() is not suppo9rted by this implementation.
@item ENOTDIR
A component of the path prefix is not a directory.
@item EROFS
The directory entry specified resides on a read-only file system.

@end table

@subheading DESCRIPTION:

If {_POSIX_DUMP} is defined:

   The @code{dump_setpath} function defines the pathname where process
   dumps are written.  The pathname pointed to by @code{path} shall 
   define where a process dump file will be written if the calling 
   process terminates with a dump file.  The @code{path} argument 
   shall not name a directory.

   If the @code{path} argument is NULL, the system shall not write a
   process dump file if the calling process terminates with a dump 
   file.  If the @code{dump_setpath} function fails, the pathname for
   writing process dumps shall not change.

Otherwise:

   The @code{dump_setpath} function shall fail.

@subheading NOTES: