xref: /dragonfly/share/man/man9/hexncpy.9 (revision 8af44722)
1.\"
2.\" Copyright (c) 2013 The DragonFly Project.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\"
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in
12.\"    the documentation and/or other materials provided with the
13.\"    distribution.
14.\" 3. Neither the name of The DragonFly Project nor the names of its
15.\"    contributors may be used to endorse or promote products derived
16.\"    from this software without specific, prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd February 7, 2012
32.Dt HEXNCPY 9
33.Os
34.Sh NAME
35.Nm hexncpy
36.Nd converts a block of bytes into an ASCII string
37.Sh SYNOPSIS
38.In sys/libkern.h
39.Ft char *
40.Fn hexncpy "const u_char *inb" "int inlen" "char *outb" "int outlen" "const char *sep"
41.Sh DESCRIPTION
42The
43.Fn hexncpy
44function converts a block of bytes to an ASCII string which represents
45its values as hex digits.
46.Bl -tag -width indent
47.It Fa inb
48Pointer to the array of bytes to be converted.
49.It Fa inlen
50Number of bytes to parse from the input buffer.
51.It Fa outb
52Buffer to store the resulting string.
53It should be large enough to hold all the hexadecimal characters that want to
54be represented, the separators and the null terminator character.
55.It Fa outlen
56Number of bytes to store in the buffer.
57.It Fa sep
58Character to be used as separator
59.El
60.Sh RETURN VALUES
61The
62.Fn hexncpy
63function returns a pointer to the string containing an ASCII representation
64as hex digits of the values passed in
65.Fa inb .
66.Sh SEE ALSO
67.Xr ascii 7 ,
68.Xr hexdump 9 ,
69.Xr kether_ntoa 9
70.Sh HISTORY
71The
72.Fn hexncpy
73function first appeared in
74.Dx 3.3 .
75