summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2000-09-14 20:23:17 +0000
committerRichard Levitte <levitte@openssl.org>2000-09-14 20:23:17 +0000
commite38dabbc0c678739d79971c04f2852b71f90a59f (patch)
treeb739d53da7dc1a4d91f899d0f2b9a7e418edb462 /doc
parent54731d75d70c3cae0f1b65eef960c49dd51307ce (diff)
BIO_seed() and BIO_tell() were documented in two other documents,
which is redundant. Instead, move them to their own page.
Diffstat (limited to 'doc')
-rw-r--r--doc/crypto/BIO_seek.pod30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/crypto/BIO_seek.pod b/doc/crypto/BIO_seek.pod
new file mode 100644
index 0000000000..3f92d5cbd5
--- /dev/null
+++ b/doc/crypto/BIO_seek.pod
@@ -0,0 +1,30 @@
+=pod
+
+=head1 NAME
+
+BIO_seek, BIO_tell - file BIO operations
+
+=head1 SYNOPSIS
+
+ #include <openssl/bio.h>
+
+ #define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
+ #define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
+
+=head1 DESCRIPTION
+
+BIO_seek() sets the file position pointer to B<ofs> bytes from start of file.
+
+BIO_tell() returns the current file position.
+
+=head1 RETURN VALUES
+
+BIO_seek() returns the same value as the underlying fseek() function:
+0 for success or -1 for failure.
+
+BIO_tell() returns the current file position.
+
+=head1 SEE ALSO
+
+TBA
+