doc/unw_apply_reg_state.man

   1 '\" t
   2 .\" Manual page created with latex2man on Wed Aug 16 11:09:44 PDT 2017
   3 .\" NOTE: This file is generated, DO NOT EDIT.
   4 .de Vb
   5 .ft CW
   6 .nf
   7 ..
   8 .de Ve
   9 .ft R
  10
  11 .fi
  12 ..
  13 .TH "UNW\\_APPLY\\_REG\\_STATE" "3" "16 August 2017" "Programming Library " "Programming Library "
  14 .SH NAME
  15 unw_apply_reg_state
  16 \-\- apply a register state update to a cursor
  17 .PP
  18 .SH SYNOPSIS
  19
  20 .PP
  21 #include <libunwind.h>
  22 .br
  23 .PP
  24 int
  25 unw_apply_reg_state(unw_cursor_t *cp,
  26 void *reg_states_data);
  27 .br
  28 .PP
  29 .SH DESCRIPTION
  30
  31 .PP
  32 The unw_apply_reg_state()
  33 routine updates the register values
  34 of a cursor according to the instructions in reg_states_data,
  35 which have been obtained by calling unw_reg_states_iterate\&.
  36 .PP
  37 .SH RETURN VALUE
  38
  39 .PP
  40 On successful completion, unw_apply_reg_state()
  41 returns 0.
  42 Otherwise the negative value of one of the error\-codes below is
  43 returned.
  44 .PP
  45 .SH THREAD AND SIGNAL SAFETY
  46
  47 .PP
  48 unw_apply_reg_state()
  49 is thread\-safe. If cursor cp
  50 is
  51 in the local address\-space, this routine is also safe to use from a
  52 signal handler.
  53 .PP
  54 .SH ERRORS
  55
  56 .PP
  57 .TP
  58 UNW_EUNSPEC
  59  An unspecified error occurred.
  60 .TP
  61 UNW_ENOINFO
  62  Libunwind
  63 was unable to locate
  64 unwind\-info for the procedure.
  65 .TP
  66 UNW_EBADVERSION
  67  The unwind\-info for the procedure has
  68 version or format that is not understood by libunwind\&.
  69 .PP
  70 In addition, unw_apply_reg_state()
  71 may return any error
  72 returned by the access_mem()
  73 call\-back (see
  74 unw_create_addr_space(3)).
  75 .PP
  76 .SH SEE ALSO
  77
  78 .PP
  79 libunwind(3),
  80 unw_reg_states_iterate(3)
  81 .PP
  82 .SH AUTHOR
  83
  84 .PP
  85 David Mosberger\-Tang
  86 .br
  87 Email: \fBdmosberger@gmail.com\fP
  88 .br
  89 WWW: \fBhttp://www.nongnu.org/libunwind/\fP\&.
  90 .\" NOTE: This file is generated, DO NOT EDIT.