LibreOffice: rtl/random.h Source File

LibreOffice LibreOffice 4.4 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

random.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef INCLUDED_RTL_RANDOM_H
21 #define INCLUDED_RTL_RANDOM_H
22
23 #include <sal/config.h>
24
25 #include <sal/saldllapi.h>
26 #include <sal/types.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /*========================================================================
33 *
34 * rtlRandom interface.
35 *
36 *======================================================================*/
39 typedef void* rtlRandomPool;
40
41
44 enum __rtl_RandomError
45 {
46 rtl_Random_E_None,
47 rtl_Random_E_Argument,
48 rtl_Random_E_Memory,
49 rtl_Random_E_Unknown,
50 rtl_Random_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
51 };
52
55 typedef enum __rtl_RandomError rtlRandomError;
56
57
61 SAL_DLLPUBLIC rtlRandomPool SAL_CALL rtl_random_createPool (void) SAL_THROW_EXTERN_C();
62
63
68 SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool (
69 rtlRandomPool Pool
70 ) SAL_THROW_EXTERN_C();
71
72
79 SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes (
80 rtlRandomPool Pool,
81 const void *Buffer,
82 sal_Size Bytes
83 ) SAL_THROW_EXTERN_C();
84
85
92 SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_getBytes (
93 rtlRandomPool Pool,
94 void *Buffer,
95 sal_Size Bytes
96 ) SAL_THROW_EXTERN_C();
97
98 /*========================================================================
99 *
100 * The End.
101 *
102 *======================================================================*/
103
104 #ifdef __cplusplus
105 }
106 #endif
107
108 #endif // INCLUDED_RTL_RANDOM_H
109
110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
rtl_Random_E_FORCE_EQUAL_SIZE
Definition: random.h:50
saldllapi.h
rtlRandomPool
void * rtlRandomPool
Random Pool opaque type.
Definition: random.h:39
rtl_Random_E_Unknown
Definition: random.h:49
rtl_random_addBytes
SAL_DLLPUBLIC rtlRandomError rtl_random_addBytes(rtlRandomPool Pool, const void *Buffer, sal_Size Bytes) SAL_THROW_EXTERN_C()
Add bytes to a Random Pool.
__rtl_RandomError
__rtl_RandomError
Error Code enumeration.
Definition: random.h:44
types.h
rtl_random_destroyPool
SAL_DLLPUBLIC void rtl_random_destroyPool(rtlRandomPool Pool) SAL_THROW_EXTERN_C()
Destroy a Random Pool.
rtl_random_getBytes
SAL_DLLPUBLIC rtlRandomError rtl_random_getBytes(rtlRandomPool Pool, void *Buffer, sal_Size Bytes) SAL_THROW_EXTERN_C()
Retrieve bytes from a Random Pool.
rtl_Random_E_Memory
Definition: random.h:48
rtl_Random_E_Argument
Definition: random.h:47
SAL_THROW_EXTERN_C
#define SAL_THROW_EXTERN_C()
Nothrow specification for C functions.
Definition: types.h:354
rtlRandomError
enum __rtl_RandomError rtlRandomError
Error Code type.
Definition: random.h:55
config.h
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
rtl_Random_E_None
Definition: random.h:46
rtl_random_createPool
SAL_DLLPUBLIC rtlRandomPool rtl_random_createPool(void) SAL_THROW_EXTERN_C()
Create a Random Pool.