usr/src/man/man3proc/ps_pglobal_lookup.3proc

   1 '\" te
   2 .\"  Copyright (c) 1998 Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PS_PGLOBAL_LOOKUP 3PROC "Jan 16, 1998"
   7 .SH NAME
   8 ps_pglobal_lookup, ps_pglobal_sym \- look up a symbol in the symbol table of
   9 the load object in the target process
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <proc_service.h>
  14
  15 \fBps_err_e\fR \fBps_pglobal_lookup\fR(\fBstruct ps_prochandle *\fR\fIph\fR,
  16      \fBconst char *\fR\fIobject_name\fR, \fBconst char *\fR\fIsym_name\fR,
  17      \fBpsaddr_t *\fR\fIsym_addr\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBps_err_e\fR \fBps_pglobal_sym\fR(\fBstruct ps_prochandle *\fR\fIph\fR,
  23      \fBconst char *\fR\fIobject_name\fR, \fBconst char *\fR\fIsym_name\fR,
  24      \fBps_sym_t *\fR\fIsym\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .LP
  29 \fBps_pglobal_lookup()\fR looks up the symbol \fIsym_name\fR in the symbol
  30 table of the load object \fIobject_name\fR in the target process identified by
  31 \fIph\fR. It returns the symbol's value as an address in the target process in
  32 \fB*\fR\fIsym_addr.\fR
  33 .sp
  34 .LP
  35 \fBps_pglobal_sym()\fR looks up the symbol \fIsym_name\fR in the symbol table
  36 of the load object \fIobject_name\fR in the target process identified by
  37 \fIph\fR. It returns the symbol table entry in \fB*\fR\fIsym.\fR The value in
  38 the symbol table entry is the symbol's value as an address in the target
  39 process.
  40 .SH RETURN VALUES
  41 .ne 2
  42 .na
  43 \fB\fBPS_OK\fR \fR
  44 .ad
  45 .RS 13n
  46 The call completed successfully.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBPS_NOSYM\fR \fR
  53 .ad
  54 .RS 13n
  55 The specified symbol was not found.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBPS_ERR\fR \fR
  62 .ad
  63 .RS 13n
  64 The function did not return successfully.
  65 .RE
  66
  67 .SH ATTRIBUTES
  68 .LP
  69 See \fBattributes\fR(5) for description of the following attributes:
  70 .sp
  71
  72 .sp
  73 .TS
  74 box;
  75 c | c
  76 l | l .
  77 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  78 _
  79 MT Level        Safe
  80 .TE
  81
  82 .SH SEE ALSO
  83 .LP
  84 \fBkill\fR(2), \fBlibc_db\fR(3LIB), \fBproc_service\fR(3PROC),
  85 \fBattributes\fR(5), \fBthreads\fR(5)