MSwindows.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011 Symscape
9 Copyright (C) 2019 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Namespace
28 Foam::MSwindows
29
30Description
31 OS-specific functions implemented for MS-windows.
32
33SourceFiles
34 MSwindows.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef Foam_MSwindows_H
39#define Foam_MSwindows_H
40
41#include "className.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47
48// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49
50namespace MSwindows
51{
52 //- Declare namespace and its debug switch
53 NamespaceName("MSwindows");
54
55 //- The last Windows API error from GetLastError
56 std::string lastError();
57
58 //- The user-name from Windows API GetUserName
59 std::string userName();
60}
61
62// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
63
64} // End namespace Foam
65
66// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67
68#endif
69
70// ************************************************************************* //
Macro definitions for declaring ClassName(), NamespaceName(), etc.
#define NamespaceName(TypeNameString)
Add typeName information from argument TypeNameString to a namespace.
Definition: className.H:73
std::string userName()
The user-name from Windows API GetUserName.
Definition: MSwindows.C:297
std::string lastError()
The last Windows API error from GetLastError.
Definition: MSwindows.C:253
Namespace for OpenFOAM.