ObjFW
OFGetWindowsRegistryValueFailedException.h
1 /*
2  * Copyright (c) 2008-2023 Jonathan Schleifer <js@nil.im>
3  *
4  * All rights reserved.
5  *
6  * This file is part of ObjFW. It may be distributed under the terms of the
7  * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
8  * the packaging of this file.
9  *
10  * Alternatively, it may be distributed under the terms of the GNU General
11  * Public License, either version 2 or 3, which can be found in the file
12  * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
13  * file.
14  */
15 
16 #import "OFException.h"
17 #import "OFWindowsRegistryKey.h"
18 
19 #include <windows.h>
20 
21 OF_ASSUME_NONNULL_BEGIN
22 
31 {
32  OFWindowsRegistryKey *_registryKey;
33  OFString *_Nullable _valueName;
34  LSTATUS _status;
35  OF_RESERVE_IVARS(OFGetWindowsRegistryValueFailedException, 4)
36 }
37 
41 @property (readonly, nonatomic) OFWindowsRegistryKey *registryKey;
42 
46 @property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *valueName;
47 
51 @property (readonly, nonatomic) LSTATUS status;
52 
63 + (instancetype)exceptionWithRegistryKey: (OFWindowsRegistryKey *)registryKey
64  valueName: (nullable OFString *)valueName
65  status: (LSTATUS)status;
66 
67 + (instancetype)exception OF_UNAVAILABLE;
68 
79 - (instancetype)initWithRegistryKey: (OFWindowsRegistryKey *)registryKey
80  valueName: (nullable OFString *)valueName
81  status: (LSTATUS)status OF_DESIGNATED_INITIALIZER;
82 
83 - (instancetype)init OF_UNAVAILABLE;
84 @end
85 
86 OF_ASSUME_NONNULL_END
A class for handling strings.
Definition: OFString.h:134
An exception indicating that getting a Windows registry value failed.
Definition: OFGetWindowsRegistryValueFailedException.h:30
The base class for all exceptions in ObjFW.
Definition: OFException.h:150
OFString * valueName
The name of the value which could not be retrieved.
Definition: OFGetWindowsRegistryValueFailedException.h:46