9762 Split the custr functions into their own library
[unleashed.git] / usr / src / man / man3tsol / hextob.3tsol
blob2a75eafd03bc7cbe7634aa7fddd0967ea1ef642a
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 HEXTOB 3TSOL "Jul 20, 2007"
7 .SH NAME
8 hextob, htobsl, htobclear \- convert hexadecimal string to binary label
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBcc\fR [\fIflag\fR...] \fIfile\fR... \fB-ltsol\fR [\fIlibrary\fR...]
13 .fi
15 .LP
16 .nf
17 #include <tsol/label.h>
19 \fBint htobsl\fR(\fBconst char *\fR\fIs\fR, \fBm_label_t *\fR\fIlabel\fR);
20 .fi
22 .LP
23 .nf
24 \fBint\fR \fBhtobclear\fR(\fBconst char *\fR\fIs\fR, \fBm_label_t *\fR\fIclearance\fR);
25 .fi
27 .SH DESCRIPTION
28 .sp
29 .LP
30 These functions convert hexadecimal string representations of internal label
31 values into binary labels.
32 .sp
33 .LP
34 The \fBhtobsl()\fR function converts into a binary sensitivity label, a
35 hexadecimal string of the form:
36 .sp
37 .in +2
38 .nf
39 0x\fIsensitivity_label_hexadecimal_value\fR
40 .fi
41 .in -2
42 .sp
44 .sp
45 .LP
46 The \fBhtobclear()\fR function converts into a binary clearance, a hexadecimal
47 string of the form:
48 .sp
49 .in +2
50 .nf
51 0x\fIclearance_hexadecimal_value\fR
52 .fi
53 .in -2
54 .sp
56 .SH RETURN VALUES
57 .sp
58 .LP
59 These functions return non-zero if the conversion was successful, otherwise
60 zero is returned.
61 .SH ATTRIBUTES
62 .sp
63 .LP
64 See \fBattributes\fR(5) for descriptions of the following attributes:
65 .sp
67 .sp
68 .TS
69 box;
70 c | c
71 l | l .
72 ATTRIBUTE TYPE  ATTRIBUTE VALUE
74 Interface Stability     Obsolete
76 MT-Level        MT-Safe
77 .TE
79 .sp
80 .LP
81 These functions are obsolete and retained for ease of porting. They might be
82 removed in a future Solaris Trusted Extensions release. Use the
83 \fBstr_to_label\fR(3TSOL) function instead.
84 .SH SEE ALSO
85 .sp
86 .LP
87 \fBlibtsol\fR(3LIB), \fBstr_to_label\fR(3TSOL), \fBattributes\fR(5),
88 \fBlabels\fR(5)
89 .SH NOTES
90 .sp
91 .LP
92 The functionality described on this manual page is available only if the system
93 is configured with Trusted Extensions.