usr/src/man/man3dns_sd/TXTRecordCreate.3dns_sd

   1 '\" te
   2 .\" Copyright (c) 2007, 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 TXTRECORDCREATE 3DNS_SD "Aug 20, 2007"
   7 .SH NAME
   8 TXTRecordCreate, TXTRecordDeallocate, TXTRecordSetValue, TXTRecordRemoveValue,
   9 TXTRecordGetLength, TXTRecordGetBytesPtr, TXTRecordContainsKey,
  10 TXTRecordGetValuePtr, TXTRecordGetCount, TXTRecordGetItemAtIndex \- DNS TXT
  11 record manipulation functions
  12 .SH SYNOPSIS
  13 .LP
  14 .nf
  15 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-ldns_sd\fR [ \fIlibrary\fR ... ]
  16 #include <dns_sd.h>
  17
  18 \fBvoid\fR \fBTXTRecordCreate\fR(\fBTXTRecordRef\fR *\fItxtRecord\fR, \fBuint16_t\fR \fIbufferLen\fR,
  19      \fBvoid\fR *\fIbuffer\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBvoid\fR \fBTXTRecordDeallocate\fR(\fBTXTRecordRef\fR*\fItxtRecord\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBDNSServiceErrorType\fR \fBtxtRecord\fR(\fBTXTRecordRef\fR *\fItxtRecord\fR,
  30      \fBconst char\fR *\fIkey\fR, \fBuint8_t\fR \fIvalueSize\fR, \fBconst void\fR *\fIvalue\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBDNSServiceErrorType\fR \fBTXTRecordRemoveValue\fR(\fBTXTRecordRef\fR *\fItxtRecord\fR,
  36      \fBconst char\fR *\fIkey\fR);
  37 .fi
  38
  39 .LP
  40 .nf
  41 \fBuint16_t\fR \fBTXTRecordGetLength\fR(\fBconst TXTRecordRef\fR *\fItxtRecord\fR);
  42 .fi
  43
  44 .LP
  45 .nf
  46 \fBconst void\fR *\fBTXTRecordGetBytesPtr\fR(\fBconst TXTRecordRef\fR *\fItxtRecord\fR);
  47 .fi
  48
  49 .LP
  50 .nf
  51 \fBint\fR *\fBTXTRecordContainsKey\fR(\fBuint16_t\fR *\fItxtLen\fR,
  52      \fBconst void\fR *\fItxtRecord\fR, \fBconst char\fR *\fIkey\fR);
  53 .fi
  54
  55 .LP
  56 .nf
  57 \fBconst void\fR *\fBTXTRecordGetValuePtr\fR(\fBuint16_t\fR *\fItxtLen\fR,
  58      \fBconst void\fR *\fItxtRecord\fR, \fBconst char\fR *\fIkey\fR,
  59      \fBuint8_t\fR *\fIvalueLen\fR);
  60 .fi
  61
  62 .LP
  63 .nf
  64 \fBuint16_t\fR *\fBTXTRecordGetCount\fR(\fBuint16_t\fR *\fItxtLen\fR,
  65      \fBconst void\fR *\fItxtRecord\fR);
  66 .fi
  67
  68 .LP
  69 .nf
  70 \fBDNSServiceErrorType\fR \fBTXTRecordGetItemAtIndex\fR(\fBuint16_t\fR *\fItxtLen,\fR
  71      \fBconst void\fR *\fItxtRecord\fR, \fBuint16_t\fR *\fIindex\fR,
  72      \fBuint16_t\fR *\fIkeyBufLen\fR, \fBchar\fR *\fIkey\fR,
  73      \fBuint8_t\fR *\fIvalueLen\fR, \fBconst void\fR **\fIvalue\fR);
  74 .fi
  75
  76 .SH DESCRIPTION
  77 .sp
  78 .LP
  79 These functions in the \fBlibdns_sd\fR library allow applications to create and
  80 to manipulate \fBTXT\fR resource records. \fBTXT\fR resource records enable
  81 applications to include service specific information, other than a host name
  82 and port number, as part of the service registration.
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for description of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 Interface Stability     Committed
  97 _
  98 MT-Level        Safe
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBattributes\fR(5)