share/man/man3picl/picl_initialize.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_INITIALIZE 3PICL "Mar 28, 2000"
   7 .SH NAME
   8 picl_initialize \- initiate a session with the PICL daemon
   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_initialize\fR(\fBvoid\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBpicl_initialize()\fR function opens the daemon door file and initiates a
  22 session with the PICL daemon running on the system.
  23 .SH RETURN VALUES
  24 .sp
  25 .LP
  26 Upon successful completion, \fB0\fR is returned. On failure, this function
  27 returns a non-negative integer, \fBPICL_FAILURE\fR.
  28 .SH ERRORS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fBPICL_NOTSUPPORTED\fR\fR
  33 .ad
  34 .RS 21n
  35 Version not supported
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBPICL_FAILURE\fR\fR
  42 .ad
  43 .RS 21n
  44 General system failure
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBPICL_NORESPONSE\fR\fR
  51 .ad
  52 .RS 21n
  53 Daemon not responding
  54 .RE
  55
  56 .SH ATTRIBUTES
  57 .sp
  58 .LP
  59 See \fBattributes\fR(5)  for descriptions of the following attributes:
  60 .sp
  61
  62 .sp
  63 .TS
  64 box;
  65 c | c
  66 l | l .
  67 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  68 _
  69 MT-Level        MT-Safe
  70 .TE
  71
  72 .SH SEE ALSO
  73 .sp
  74 .LP
  75 \fBpicl_shutdown\fR(3PICL), \fBattributes\fR(5)