[832e33c] | 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 | |
---|
[d1a859c] | 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}. |
---|
[832e33c] | 18 | |
---|
| 19 | The directives provided by the process dump control manager are: |
---|
| 20 | |
---|
| 21 | @itemize @bullet |
---|
[8c82d8d1] | 22 | @item @code{dump_setpath} - Dump File Control |
---|
[832e33c] | 23 | @end itemize |
---|
| 24 | |
---|
| 25 | @section Background |
---|
| 26 | |
---|
[571a915] | 27 | There is no background. |
---|
| 28 | |
---|
[832e33c] | 29 | @section Operations |
---|
| 30 | |
---|
[571a915] | 31 | There is no discussion of the operations. |
---|
| 32 | |
---|
[832e33c] | 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 |
---|
[8c82d8d1] | 41 | @subsection dump_setpath - Dump File Control |
---|
[832e33c] | 42 | |
---|
| 43 | @subheading CALLING SEQUENCE: |
---|
| 44 | |
---|
| 45 | @ifset is-C |
---|
| 46 | @example |
---|
[9c79229] | 47 | #include <dump.h> |
---|
| 48 | |
---|
[832e33c] | 49 | int dump_setpath( |
---|
[8c82d8d1] | 50 | const char *path |
---|
[832e33c] | 51 | ); |
---|
| 52 | @end example |
---|
| 53 | @end ifset |
---|
| 54 | |
---|
| 55 | @ifset is-Ada |
---|
| 56 | @end ifset |
---|
| 57 | |
---|
| 58 | @subheading STATUS CODES: |
---|
| 59 | |
---|
[16bed8a] | 60 | @table @b |
---|
[8c82d8d1] | 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. |
---|
[d1a859c] | 65 | |
---|
[8c82d8d1] | 66 | @item ENAMETOOLONG |
---|
[d5ef5bd1] | 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} |
---|
[8c82d8d1] | 69 | is in effect. |
---|
[d1a859c] | 70 | |
---|
[8c82d8d1] | 71 | @item ENOENT |
---|
| 72 | The path argument points to an empty string. |
---|
[d1a859c] | 73 | |
---|
[8c82d8d1] | 74 | @item ENOTDIR |
---|
| 75 | A component of the path prefix is not a directory. |
---|
[d1a859c] | 76 | |
---|
[8c82d8d1] | 77 | @item EROFS |
---|
| 78 | The directory entry specified resides on a read-only file system. |
---|
[16bed8a] | 79 | |
---|
| 80 | @end table |
---|
| 81 | |
---|
[832e33c] | 82 | @subheading DESCRIPTION: |
---|
| 83 | |
---|
[d1a859c] | 84 | The @code{dump_setpath} function defines the pathname where process |
---|
[219aedad] | 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. |
---|
[c40ad43] | 89 | |
---|
[219aedad] | 90 | If the @code{path} argument is NULL, the system does not write a |
---|
[d1a859c] | 91 | process dump file if the calling process terminates with a dump |
---|
| 92 | file. If the @code{dump_setpath} function fails, the pathname for |
---|
[219aedad] | 93 | writing process dumps does not change. |
---|
[8c82d8d1] | 94 | |
---|
[832e33c] | 95 | @subheading NOTES: |
---|
| 96 | |
---|
[d1a859c] | 97 | The @code{_POSIX_DUMP} feature flag is defined to indicate |
---|
| 98 | this service is available. |
---|