share/man/man3picl/picl_wait.3picl

   1 '\" te
   2 .\" Copyright (c) 2000, 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 PICL_WAIT 3PICL "Mar 28, 2000"
   7 .SH NAME
   8 picl_wait \- wait for PICL tree to refresh
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicl\fR [ \fIlibrary\fR... ]
  13 #include <picl.h>
  14
  15 \fBint\fR \fBpicl_wait\fR(\fBint\fR \fIto_secs\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBpicl_wait()\fR function blocks the calling thread until the PICL tree is
  22 refreshed. The \fIto_secs\fR argument specifies the timeout for the call in
  23 number of seconds. A value of \(mi1 for \fIto_secs\fR specifies no timeout.
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 The \fBpicl_wait()\fR function returns \fB0\fR to indicate that PICL tree has
  28 refreshed. Otherwise, a non-negative integer is returned to indicate error.
  29 .SH ERRORS
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fBPICL_NOTINITIALIZED\fR\fR
  34 .ad
  35 .RS 23n
  36 Session not initialized
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBPICL_NORESPONSE\fR\fR
  43 .ad
  44 .RS 23n
  45 Daemon not responding
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBPICL_TIMEDOUT\fR\fR
  52 .ad
  53 .RS 23n
  54 Timed out waiting for refresh
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBPICL_FAILURE\fR\fR
  61 .ad
  62 .RS 23n
  63 General system failure
  64 .RE
  65
  66 .SH ATTRIBUTES
  67 .sp
  68 .LP
  69 See \fBattributes\fR(5) for descriptions 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        MT-Safe
  80 .TE
  81
  82 .SH SEE ALSO
  83 .sp
  84 .LP
  85 \fBattributes\fR(5)