usr/src/man/man3slp/SLPDelAttrs.3slp

   1 '\" te
   2 .\" Copyright (c) 2003, 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 SLPDELATTRS 3SLP "Jan 16, 2003"
   7 .SH NAME
   8 SLPDelAttrs \- delete attributes
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lslp\fR [ \fIlibrary\fR... ]
  13 #include <slp.h>
  14
  15 \fBSLPError\fR \fBSLPDelAttrs\fR(\fBSLPHandle\fR \fIhSLP\fR, \fBconst char *\fR\fIpcURL\fR,
  16      \fBconst char *\fR\fIpcAttrs\fR, \fBSLPRegReport *\fR\fIcallback\fR, \fBvoid *\fR\fIpvCookie\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBSLPDelAttrs()\fR function deletes the selected attributes in the locale
  23 of the \fBSLPHandle\fR. If no error  occurs, the return value is \fB0\fR.
  24 Otherwise, one of the \fBSLPError\fR codes is returned.
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIhSLP\fR\fR
  30 .ad
  31 .RS 12n
  32 The language  specific \fBSLPHandle\fR to  use to delete  attributes. It cannot
  33 be \fINULL\fR.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIpcURL\fR\fR
  40 .ad
  41 .RS 12n
  42 The \fB URL\fR of the advertisement from which the attributes should be
  43 deleted.  It cannot be \fINULL\fR.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fIpcAttrs\fR\fR
  50 .ad
  51 .RS 12n
  52 A  comma-separated  list of attribute ids  for  the attributes to deregister.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIcallback\fR\fR
  59 .ad
  60 .RS 12n
  61 A callback to report the operation's completion status. It cannot be
  62 \fINULL\fR.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fIpvCookie\fR\fR
  69 .ad
  70 .RS 12n
  71 Memory passed to the callback code from the client. It cannot be \fINULL\fR.
  72 .RE
  73
  74 .SH ERRORS
  75 .sp
  76 .LP
  77 This function or its callback may return any \fBSLP\fR error code. See the
  78 ERRORS section in \fBslp_api\fR(3SLP).
  79 .SH EXAMPLES
  80 .LP
  81 \fBExample 1 \fRDeleting Attributes
  82 .sp
  83 .LP
  84 Use the following example to delete the \fBlocation\fR and \fBdpi\fR attributes
  85 for the \fBURL\fR \fBservice:printer:lpr://serv/queve1\fR
  86
  87 .sp
  88 .in +2
  89 .nf
  90 SLPHandle hSLP;
  91 SLPError err;
  92 SLPRegReport report;
  93
  94 err = SLPDelAttrs(hSLP, "service:printer:lpr://serv/queue1",
  95     "location,dpi", report, NULL);
  96 .fi
  97 .in -2
  98
  99 .SH ENVIRONMENT VARIABLES
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBSLP_CONF_FILE\fR\fR
 104 .ad
 105 .RS 17n
 106 When set, use this file for configuration.
 107 .RE
 108
 109 .SH SEE ALSO
 110 .sp
 111 .LP
 112 \fBslpd\fR(1M), \fBslp_api\fR(3SLP), \fBslp.conf\fR(4), \fBslpd.reg\fR(4),
 113 \fBattributes\fR(5)
 114 .sp
 115 .LP
 116 \fISystem Administration Guide: Network Services\fR
 117 .sp
 118 .LP
 119 Kempf, J. and Guttman, E. \fIRFC 2614, An API for Service Location\fR. The
 120 Internet Society. June 1999.