ObjFW
OFCreateWindowsRegistryKeyFailedException.h
1 /*
2  * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
3  *
4  * All rights reserved.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License version 3.0 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
13  * version 3.0 for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * version 3.0 along with this program. If not, see
17  * <https://www.gnu.org/licenses/>.
18  */
19 
20 #import "OFException.h"
21 #import "OFWindowsRegistryKey.h"
22 
23 #include <windows.h>
24 
25 OF_ASSUME_NONNULL_BEGIN
26 
34 {
35  OFWindowsRegistryKey *_registryKey;
36  OFString *_path;
37  DWORD _options;
38  REGSAM _accessRights;
39  LPSECURITY_ATTRIBUTES _Nullable _securityAttributes;
40  LSTATUS _status;
42 }
43 
47 @property (readonly, nonatomic) OFWindowsRegistryKey *registryKey;
48 
52 @property (readonly, nonatomic) OFString *path;
53 
57 @property (readonly, nonatomic) REGSAM accessRights;
58 
62 @property OF_NULLABLE_PROPERTY (readonly, nonatomic)
63  LPSECURITY_ATTRIBUTES securityAttributes;
64 
68 @property (readonly, nonatomic) DWORD options;
69 
73 @property (readonly, nonatomic) LSTATUS status;
74 
89 + (instancetype)
90  exceptionWithRegistryKey: (OFWindowsRegistryKey *)registryKey
91  path: (OFString *)path
92  accessRights: (REGSAM)accessRights
93  securityAttributes: (nullable LPSECURITY_ATTRIBUTES)securityAttributes
94  options: (DWORD)options
95  status: (LSTATUS)status;
96 
97 - (instancetype)init OF_UNAVAILABLE;
98 
113 - (instancetype)
114  initWithRegistryKey: (OFWindowsRegistryKey *)registryKey
115  path: (OFString *)path
116  accessRights: (REGSAM)accessRights
117  securityAttributes: (nullable LPSECURITY_ATTRIBUTES)securityAttributes
118  options: (DWORD)options
119  status: (LSTATUS)status OF_DESIGNATED_INITIALIZER;
120 @end
121 
122 OF_ASSUME_NONNULL_END
A class for handling strings.
Definition: OFString.h:142
An exception indicating that creating a Windows registry key failed.
Definition: OFCreateWindowsRegistryKeyFailedException.h:33
The base class for all exceptions in ObjFW.
Definition: OFException.h:156