Document ret and store function for the unsigned fixed size integer types.

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@17427 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2006-05-04 09:40:35 +00:00
parent 93f0be5d42
commit 83b9ad094c

View File

@@ -1,4 +1,4 @@
.\" Copyright (c) 2003 - 2005 Kungliga Tekniska H<>gskolan .\" Copyright (c) 2003 - 2006 Kungliga Tekniska H<>gskolan
.\" (Royal Institute of Technology, Stockholm, Sweden). .\" (Royal Institute of Technology, Stockholm, Sweden).
.\" All rights reserved. .\" All rights reserved.
.\" .\"
@@ -31,7 +31,7 @@
.\" .\"
.\" $Id$ .\" $Id$
.\" .\"
.Dd May 10, 2005 .Dd May 4, 2006
.Dt KRB5_STORAGE 3 .Dt KRB5_STORAGE 3
.Os HEIMDAL .Os HEIMDAL
.Sh NAME .Sh NAME
@@ -53,10 +53,16 @@
.Nm krb5_storage_to_data , .Nm krb5_storage_to_data ,
.Nm krb5_store_int32 , .Nm krb5_store_int32 ,
.Nm krb5_ret_int32 , .Nm krb5_ret_int32 ,
.Nm krb5_store_uint32 ,
.Nm krb5_ret_uint32 ,
.Nm krb5_store_int16 , .Nm krb5_store_int16 ,
.Nm krb5_ret_int16 , .Nm krb5_ret_int16 ,
.Nm krb5_store_uint16 ,
.Nm krb5_ret_uint16 ,
.Nm krb5_store_int8 , .Nm krb5_store_int8 ,
.Nm krb5_ret_int8 , .Nm krb5_ret_int8 ,
.Nm krb5_store_uint8 ,
.Nm krb5_ret_uint8 ,
.Nm krb5_store_data , .Nm krb5_store_data ,
.Nm krb5_ret_data , .Nm krb5_ret_data ,
.Nm krb5_store_string , .Nm krb5_store_string ,
@@ -120,14 +126,26 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Ft krb5_error_code .Ft krb5_error_code
.Fn krb5_ret_int32 "krb5_storage *sp" "int32_t *value" .Fn krb5_ret_int32 "krb5_storage *sp" "int32_t *value"
.Ft krb5_error_code .Ft krb5_error_code
.Fn krb5_ret_uint32 "krb5_storage *sp" "u_int32_t *value"
.Ft krb5_error_code
.Fn krb5_store_uint32 "krb5_storage *sp" "u_int32_t value"
.Ft krb5_error_code
.Fn krb5_store_int16 "krb5_storage *sp" "int16_t value" .Fn krb5_store_int16 "krb5_storage *sp" "int16_t value"
.Ft krb5_error_code .Ft krb5_error_code
.Fn krb5_ret_int16 "krb5_storage *sp" "int16_t *value" .Fn krb5_ret_int16 "krb5_storage *sp" "int16_t *value"
.Ft krb5_error_code .Ft krb5_error_code
.Fn krb5_store_uint16 "krb5_storage *sp" "u_int16_t value"
.Ft krb5_error_code
.Fn krb5_ret_uint16 "krb5_storage *sp" "u_int16_t *value"
.Ft krb5_error_code
.Fn krb5_store_int8 "krb5_storage *sp" "int8_t value" .Fn krb5_store_int8 "krb5_storage *sp" "int8_t value"
.Ft krb5_error_code .Ft krb5_error_code
.Fn krb5_ret_int8 "krb5_storage *sp" "int8_t *value" .Fn krb5_ret_int8 "krb5_storage *sp" "int8_t *value"
.Ft krb5_error_code .Ft krb5_error_code
.Fn krb5_store_uint8 "krb5_storage *sp" "u_int8_t value"
.Ft krb5_error_code
.Fn krb5_ret_uint8 "krb5_storage *sp" "u_int8_t *value"
.Ft krb5_error_code
.Fn krb5_store_data "krb5_storage *sp" "krb5_data data" .Fn krb5_store_data "krb5_storage *sp" "krb5_data data"
.Ft krb5_error_code .Ft krb5_error_code
.Fn krb5_ret_data "krb5_storage *sp" "krb5_data *data" .Fn krb5_ret_data "krb5_storage *sp" "krb5_data *data"
@@ -315,11 +333,17 @@ functions move the current offset forward when the functions returns.
.Pp .Pp
.Fn krb5_store_int32 , .Fn krb5_store_int32 ,
.Fn krb5_ret_int32 , .Fn krb5_ret_int32 ,
.Fn krb5_store_uint32 ,
.Fn krb5_ret_uint32 ,
.Fn krb5_store_int16 , .Fn krb5_store_int16 ,
.Fn krb5_ret_int16 , .Fn krb5_ret_int16 ,
.Fn krb5_store_uint16 ,
.Fn krb5_ret_uint16 ,
.Fn krb5_store_int8 , .Fn krb5_store_int8 ,
and
.Fn krb5_ret_int8 .Fn krb5_ret_int8
.Fn krb5_store_uint8 ,
and
.Fn krb5_ret_uint8
stores and reads an integer from stores and reads an integer from
.Fa sp .Fa sp
in the byte order specified by the flags set on the in the byte order specified by the flags set on the