Files
sparkle-project.github.io/documentation/api-reference/_s_u_errors_8h_source.html
T
2021-09-03 19:38:30 -07:00

172 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Sparkle: Sparkle/SUErrors.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="icon_32x32@2x.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Sparkle
&#160;<span id="projectnumber">2.0.0</span>
</div>
<div id="projectbrief">A software update framework for macOS</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_3429d7ca3cc00bc309a2ec9474a0a508.html">Sparkle</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SUErrors.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// SUErrors.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Sparkle</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// Created by C.W. Betts on 10/13/14.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// Copyright (c) 2014 Sparkle Project. All rights reserved.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#ifndef SUERRORS_H</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#define SUERRORS_H</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#if __has_feature(modules)</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#if __has_warning(&quot;-Watimport-in-framework-header&quot;</span>)</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Watimport-in-framework-header&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;@<span class="keyword">import</span> Foundation;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#import &lt;Foundation/Foundation.h&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined(BUILDING_SPARKLE_TOOL) || defined(BUILDING_SPARKLE_TESTS)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// Ignore incorrect warning</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#pragma clang diagnostic push</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Wquoted-include-in-framework-header&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#import &quot;SUExport.h&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#pragma clang diagnostic pop</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#import &lt;Sparkle/SUExport.h&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SUSparkleErrorDomain;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">typedef</span> NS_ENUM(OSStatus, SUError) {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">// Configuration phase errors</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; SUNoPublicDSAFoundError = 0001,</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; SUInsufficientSigningError = 0002,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; SUInsecureFeedURLError = 0003,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; SUInvalidFeedURLError = 0004,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; SUInvalidUpdaterError = 0005,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; SUInvalidHostBundleIdentifierError = 0006,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; SUInvalidHostVersionError = 0007,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// Appcast phase errors.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; SUAppcastParseError = 1000,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; SUNoUpdateError = 1001,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; SUAppcastError = 1002,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; SURunningFromDiskImageError = 1003,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; SUResumeAppcastError = 1004,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; SURunningTranslocated = 1005,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; SUWebKitTerminationError = 1006,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">// Download phase errors.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; SUTemporaryDirectoryError = 2000,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; SUDownloadError = 2001,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// Extraction phase errors.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; SUUnarchivingError = 3000,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; SUSignatureError = 3001,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; SUValidationError = 3002,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="comment">// Installation phase errors.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; SUFileCopyFailure = 4000,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; SUAuthenticationFailure = 4001,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; SUMissingUpdateError = 4002,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; SUMissingInstallerToolError = 4003,</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; SURelaunchError = 4004,</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; SUInstallationError = 4005,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; SUDowngradeError = 4006,</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; SUInstallationCanceledError = 4007,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; SUInstallationAuthorizeLaterError = 4008,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; SUNotAllowedInteractionError = 4009,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; SUAgentInvalidationError = 4010,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">// API misuse errors.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; SUIncorrectAPIUsageError = 5000</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;};</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="keyword">typedef</span> NS_ENUM(OSStatus, SPUNoUpdateFoundReason) {</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; SPUNoUpdateFoundReasonUnknown,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; SPUNoUpdateFoundReasonOnLatestVersion,</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; SPUNoUpdateFoundReasonOnNewerThanLatestVersion,</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; SPUNoUpdateFoundReasonSystemIsTooOld,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; SPUNoUpdateFoundReasonSystemIsTooNew</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;};</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SPUNoUpdateFoundReasonKey;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SPULatestAppcastItemFoundKey;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SPUNoUpdateFoundUserInitiatedKey;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>