120 lines
59 KiB
HTML
120 lines
59 KiB
HTML
|
<!doctype html>
|
|||
|
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-chap-21/cb-c-dictionary/open_function" data-has-hydrated="false">
|
|||
|
<head>
|
|||
|
<meta charset="UTF-8">
|
|||
|
<meta name="generator" content="Docusaurus v3.0.1">
|
|||
|
<title data-rh="true">open | Common Lisp (New) Language Reference</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://lisp-docs.github.io/cl-language-reference/img/1024px-Lisp_logo.svg.png"><meta data-rh="true" name="twitter:image" content="https://lisp-docs.github.io/cl-language-reference/img/1024px-Lisp_logo.svg.png"><meta data-rh="true" property="og:url" content="https://lisp-docs.github.io/cl-language-reference/chap-21/cb-c-dictionary/open_function"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="google-site-verification" content="Vzaw013_bfdKeUVG89Ch3W1zC9_vH9ID2dPB9Dz0vr0"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="open | Common Lisp (New) Language Reference"><meta data-rh="true" name="description" content="Expanded Reference: open"><meta data-rh="true" property="og:description" content="Expanded Reference: open"><link data-rh="true" rel="icon" href="../../img/favicon.ico"><link data-rh="true" rel="canonical" href="open_function.html"><link data-rh="true" rel="alternate" href="open_function.html" hreflang="en"><link data-rh="true" rel="alternate" href="open_function.html" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://C1F2Q5VM6X-dsn.algolia.net" crossorigin="anonymous"><link rel="preconnect" href="https://www.google-analytics.com">
|
|||
|
<link rel="preconnect" href="https://www.googletagmanager.com">
|
|||
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-8TJCE4NSF8"></script>
|
|||
|
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-8TJCE4NSF8",{})</script>
|
|||
|
|
|||
|
|
|||
|
<link rel="search" type="application/opensearchdescription+xml" title="Common Lisp (New) Language Reference" href="../../opensearch.xml"><link rel="stylesheet" href="../../assets/css/styles.f13b59fe.css">
|
|||
|
<script src="../../assets/js/runtime~main.02699c25.js" defer="defer"></script>
|
|||
|
<script src="../../assets/js/main.4f0a7a76.js" defer="defer"></script>
|
|||
|
</head>
|
|||
|
<body class="navigation-with-keyboard">
|
|||
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="open_function.html#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a href="../../../index.html" target="_blank" rel="noopener noreferrer" class="navbar__brand"><div class="navbar__logo"><img src="../../img/logo.svg" alt="Lisp Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="../../img/logo.svg" alt="Lisp Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Common Lisp Docs</b></a><a href="../../../docs/tutorial/index.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Tutorial</a><a href="../../index.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Technical Reference</a><a href="../../../docs/whylisp.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Why Lisp?</a><a href="../../../docs/howto.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Guides</a></div><div class="navbar__items navbar__items--right"><a href="../../../docs/contribute.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Contribute!</a><a href="../../../docs/help.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Getting Help</a><a href="../../../docs/about.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">About</a><a href="../../../blog.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Blog</a><a href="https://github.com/lisp-docs" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.4
|
|||
|
<!-- -->
|
|||
|
<!-- -->
|
|||
|
<p><strong>open</strong> <span><i>Function</i></span></p>
|
|||
|
<p><strong>Syntax:</strong></p>
|
|||
|
<p><span><b>open</b></span> <em>filespec</em> &key <em>direction element-type</em></p>
|
|||
|
<p><em>if-exists if-does-not-exist external-format</em></p>
|
|||
|
<p>→ stream</p>
|
|||
|
<p><strong>Arguments and Values:</strong></p>
|
|||
|
<p><em>filespec</em>—a <span><i>pathname designator</i></span> .</p>
|
|||
|
<p><em>direction</em>—one of <!-- -->:input<!-- -->, <!-- -->:output<!-- -->, <!-- -->:io<!-- -->, or <!-- -->:probe<!-- -->. The default is <!-- -->:input<!-- -->.</p>
|
|||
|
<p><em>element-type</em>—a <span><i>type specifier</i></span> for <span><i>recognizable subtype</i></span> of <span><b>character</b></span>; or a <span><i>type specifier</i></span> for a <em>finite recognizable subtype</em> of <em>integer</em> ; or one of the <span><i>symbols</i></span> <span><b>signed-byte</b></span>, <span><b>unsigned-byte</b></span>, or <!-- -->:default<!-- -->. The default is <span><b>character</b></span>.</p>
|
|||
|
<p><em>if-exists</em>—one of <!-- -->:error<!-- -->, <!-- -->:new-version<!-- -->, <!-- -->:rename<!-- -->, <!-- -->:rename-and-delete<!-- -->, <!-- -->:overwrite<!-- -->, <!-- -->:append<!-- -->, <!-- -->:supersede<!-- -->, or <span><b>nil</b></span>. The default is <!-- -->:new-version<!-- --> if the version component of <em>filespec</em> is <!-- -->:newest<!-- -->, or <!-- -->:error<!-- --> otherwise.</p>
|
|||
|
<p><em>if-does-not-exist</em>—one of <!-- -->:error<!-- -->, <!-- -->:create<!-- -->, or <span><b>nil</b></span>. The default is <!-- -->:error<!-- --> if <em>direction</em> is <!-- -->:input<!-- --> or <em>if-exists</em> is <!-- -->:overwrite<!-- --> or <!-- -->:append<!-- -->; <!-- -->:create<!-- --> if <em>direction</em> is <!-- -->:output<!-- --> or <!-- -->:io<!-- -->, and <em>if-exists</em> is neither <!-- -->:overwrite<!-- --> nor <!-- -->:append<!-- -->; or <span><b>nil</b></span> when <em>direction</em> is <!-- -->:probe<!-- -->.</p>
|
|||
|
<p><em>external-format</em>—an <span><i>external file format designator</i></span> . The default is <!-- -->:default<!-- -->.</p>
|
|||
|
<p><span><i>stream</i></span>—a <span><i>file stream</i></span> or <span><b>nil</b></span>.</p>
|
|||
|
<p><strong>Description:</strong></p>
|
|||
|
<p><span><b>open</b></span> creates, opens, and returns a <span><i>file stream</i></span> that is connected to the file specified by <em>filespec</em>. <em>Filespec</em> is the name of the file to be opened. If the <em>filespec designator</em> is a <span><i>stream</i></span>, that <span><i>stream</i></span> is not closed first or otherwise affected.</p>
|
|||
|
<p>The keyword arguments to <span><b>open</b></span> specify the characteristics of the <span><i>file stream</i></span> that is returned, and how to handle errors.</p>
|
|||
|
<p>If <em>direction</em> is <!-- -->:input<!-- --> or <!-- -->:probe<!-- -->, or if <em>if-exists</em> is not <!-- -->:new-version<!-- --> and the version component of the <em>filespec</em> is <!-- -->:newest<!-- -->, then the file opened is that file already existing in the file system that has a version greater than that of any other file in the file system whose other pathname components are the same as those of <em>filespec</em>.</p>
|
|||
|
<p>An implementation is required to recognize all of the <span><b>open</b></span> keyword options and to do something reasonable in the context of the host operating system. For example, if a file system does not support distinct file versions and does not distinguish the notions of deletion and expunging, <!-- -->:new-version<!-- --> might be treated the same as <!-- -->:rename<!-- --> or <!-- -->:supersede<!-- -->, and <!-- -->:rename-and-delete<!-- --> might be treated the same as <!-- -->:supersede<!-- -->.</p>
|
|||
|
<span><b>open</b></span>
|
|||
|
<p>:direction</p>
|
|||
|
<p>These are the possible values for <em>direction</em>, and how they affect the nature of the <span><i>stream</i></span> that is created:</p>
|
|||
|
<p>:input</p>
|
|||
|
<p>Causes the creation of an <em>input file stream</em>.</p>
|
|||
|
<p>:output</p>
|
|||
|
<p>Causes the creation of an <em>output file stream</em>.</p>
|
|||
|
<p>:io</p>
|
|||
|
<p>Causes the creation of a <em>bidirectional file stream</em>.</p>
|
|||
|
<p>:probe</p>
|
|||
|
<p>Causes the creation of a “no-directional” <span><i>file stream</i></span>; in effect, the <span><i>file stream</i></span> is</p>
|
|||
|
<p>created and then closed prior to being returned by <span><b>open</b></span>.</p>
|
|||
|
<p>:element-type</p>
|
|||
|
<p>The <em>element-type</em> specifies the unit of transaction for the <span><i>file stream</i></span>. If it is <!-- -->:default<!-- -->, the unit is determined by <span><i>file system</i></span>, possibly based on the <span><i>file</i></span>.</p>
|
|||
|
<p>:if-exists</p>
|
|||
|
<p><em>if-exists</em> specifies the action to be taken if <em>direction</em> is <!-- -->:output<!-- --> or <!-- -->:io<!-- --> and a file of the name <em>filespec</em> already exists. If <em>direction</em> is <!-- -->:input<!-- -->, not supplied, or <!-- -->:probe<!-- -->, <em>if-exists</em> is ignored. These are the results of <span><b>open</b></span> as modified by <em>if-exists</em>:</p>
|
|||
|
<p>:error</p>
|
|||
|
<p>An error of <span><i>type</i></span> <span><b>file-error</b></span> is signaled.</p>
|
|||
|
<p>:new-version</p>
|
|||
|
<p>A new file is created with a larger version number.</p>
|
|||
|
<p>:rename</p>
|
|||
|
<p>The existing file is renamed to some other name and then a new file is created.</p>
|
|||
|
<p>:rename-and-delete</p>
|
|||
|
<p>The existing file is renamed to some other name, then it is deleted but not</p>
|
|||
|
<p>expunged, and then a new file is created.</p>
|
|||
|
<span><b>open</b></span>
|
|||
|
<p>:overwrite</p>
|
|||
|
<p>Output operations on the <span><i>stream</i></span> destructively modify the existing file. If <em>direction</em></p>
|
|||
|
<p>is <!-- -->:io<!-- --> the file is opened in a bidirectional mode that allows both reading and</p>
|
|||
|
<p>writing. The file pointer is initially positioned at the beginning of the file; however,</p>
|
|||
|
<p>the file is not truncated back to length zero when it is opened.</p>
|
|||
|
<p>:append</p>
|
|||
|
<p>Output operations on the <span><i>stream</i></span> destructively modify the existing file. The file</p>
|
|||
|
<p>pointer is initially positioned at the end of the file.</p>
|
|||
|
<p>If <em>direction</em> is <!-- -->:io<!-- -->, the file is opened in a bidirectional mode that allows both</p>
|
|||
|
<p>reading and writing.</p>
|
|||
|
<p>:supersede</p>
|
|||
|
<p>The existing file is superseded; that is, a new file with the same name as the old</p>
|
|||
|
<p>one is created. If possible, the implementation should not destroy the old file until</p>
|
|||
|
<p>the new <span><i>stream</i></span> is closed.</p>
|
|||
|
<span><b>nil</b></span>
|
|||
|
<p>No file or <span><i>stream</i></span> is created; instead, <span><b>nil</b></span> is returned to indicate failure.</p>
|
|||
|
<p>:if-does-not-exist</p>
|
|||
|
<p><em>if-does-not-exist</em> specifies the action to be taken if a file of name <em>filespec</em> does not already exist. These are the results of <span><b>open</b></span> as modified by <em>if-does-not-exist</em>:</p>
|
|||
|
<p>:error</p>
|
|||
|
<p>An error of <span><i>type</i></span> <span><b>file-error</b></span> is signaled.</p>
|
|||
|
<p>:create</p>
|
|||
|
<p>An empty file is created. Processing continues as if the file had already existed but</p>
|
|||
|
<p>no processing as directed by <em>if-exists</em> is performed.</p>
|
|||
|
<span><b>nil</b></span>
|
|||
|
<p>No file or <span><i>stream</i></span> is created; instead, <span><b>nil</b></span> is returned to indicate failure.</p>
|
|||
|
<p>:external-format</p>
|
|||
|
<p>This option selects an <span><i>external file format</i></span> for the <span><i>file</i></span>: The only <span><i>standardized</i></span> value for this option is <!-- -->:default<!-- -->, although <span><i>implementations</i></span> are permitted to define additional <span><i>external file formats</i></span> and <span><i>implementation-dependent</i></span> values returned by <span><b>stream-external-format</b></span> can also be used by <span><i>conforming programs</i></span>.</p>
|
|||
|
<span><b>open</b></span>
|
|||
|
<p>The <em>external-format</em> is meaningful for any kind of <span><i>file stream</i></span> whose <span><i>element type</i></span> is a <span><i>subtype</i></span> of <span><i>character</i></span> . This option is ignored for <span><i>streams</i></span> for which it is not meaningful; however, <span><i>implementations</i></span> may define other <span><i>element types</i></span> for which it is meaningful. The consequences are unspecified if a <span><i>character</i></span> is written that cannot be represented by the given <span><i>external file format</i></span>.</p>
|
|||
|
<p>When a file is opened, a <span><i>file stream</i></span> is constructed to serve as the file system’s ambassador to the Lisp environment; operations on the <span><i>file stream</i></span> are reflected by operations on the file in the file system.</p>
|
|||
|
<p>A file can be deleted, renamed, or destructively modified by <span><b>open</b></span>.</p>
|
|||
|
<p>For information about opening relative pathnames, see Section 19.2.3 (Merging Pathnames).</p>
|
|||
|
<p><strong>Examples:</strong></p>
|
|||
|
<div class="language-lisp codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-lisp codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">(</span><span class="token car">open</span><span class="token plain"> *filespec* </span><span class="token lisp-property property" style="color:#36acaa">:direction</span><span class="token plain"> </span><span class="token lisp-property property" style="color:#36acaa">:probe</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> → #<Closed Probe File Stream...> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">setq</span><span class="token plain"> q </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">merge-pathnames</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">user-homedir-pathname</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"test"</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">→ #<PATHNAME </span><span class="token lisp-property property" style="color:#36acaa">:HOST</span><span class="token plain"> NIL </span><span class="token lisp-property property" style="color:#36acaa">:DEVICE</span><span class="token plain"> *device-name* </span><span class="token lisp-property property" style="color:#36acaa">:DIRECTORY</span><span class="token plain"> *directory-name* </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token lisp-property property" style="color:#36acaa">:NAME</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"test"</span><span class="token plain"> </span><span class="token lisp-property property" style="color:#36acaa">:TYPE</span><span class="token plain"> NIL </span><span class="token lisp-property property" style="color:#36acaa">:VERSION</span><span class="token plain"> </span><span class="token lisp-property property" style="color:#36acaa">:NEWEST></span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">open</span><span class="token plain"> *filespec* </span><span class="token lisp-property property" style="color:#36acaa">:if-does-not-exist</span><span class="token plain"> </span><span class="token lisp-property property" style="color:#36acaa">:create</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> → #<Input File Stream...> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">setq</span><span class="token plain"> s </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">open</span><span class="token plain"> *filespec* </span><span class="token lisp-property property" style="color:#36acaa">:direction</span><span class="token plain"> </span><span class="token lisp-property property" style="color:#36acaa">:probe</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><
|
|||
|
<p><strong>Affected By:</strong></p>
|
|||
|
<p>The nature and state of the host computer’s <span><i>file system</i></span>.</p>
|
|||
|
<p><strong>Exceptional Situations:</strong></p>
|
|||
|
<p>If <em>if-exists</em> is <!-- -->:error<!-- -->, (subject to the constraints on the meaning of <em>if-exists</em> listed above), an error of <span><i>type</i></span> <span><b>file-error</b></span> is signaled.</p>
|
|||
|
<p>If <em>if-does-not-exist</em> is <!-- -->:error<!-- --> (subject to the constraints on the meaning of <em>if-does-not-exist</em> listed above), an error of <span><i>type</i></span> <span><b>file-error</b></span> is signaled.</p>
|
|||
|
<p>If it is impossible for an implementation to handle some option in a manner close to what is specified here, an error of <span><i>type</i></span> <span><b>error</b></span> might be signaled.</p>
|
|||
|
<p>An error of <span><i>type</i></span> <span><b>file-error</b></span> is signaled if (wild-pathname-p <em>filespec</em>) returns true.</p>
|
|||
|
<p>An error of <span><i>type</i></span> <span><b>error</b></span> is signaled if the <em>external-format</em> is not understood by the <span><i>implementation</i></span>.</p>
|
|||
|
<p>The various <span><i>file systems</i></span> in existence today have widely differing capabilities, and some aspects of the <span><i>file system</i></span> are beyond the scope of this specification to define. A given <span><i>implementation</i></span> might not be able to support all of these options in exactly the manner stated. An <span><i>implementation</i></span> is required to recognize all of these option keywords and to try to do something “reasonable” in the context of the host <span><i>file system</i></span>. Where necessary to accomodate the <span><i>file system</i></span>, an <span><i>implementation</i></span></p>
|
|||
|
<p>deviate slightly from the semantics specified here without being disqualified for consideration as a <span><i>conforming implementation</i></span>. If it is utterly impossible for an <span><i>implementation</i></span> to handle some option in a manner similar to what is specified here, it may simply signal an error.</p>
|
|||
|
<p>With regard to the <!-- -->:element-type<!-- --> option, if a <span><i>type</i></span> is requested that is not supported by the <span><i>file system</i></span>, a substitution of types such as that which goes on in <em>upgrading</em> is permissible. As a minimum requirement, it should be the case that opening an <em>output stream</em> to a <span><i>file</i></span> in a given <span><i>element type</i></span> and later opening an <em>input stream</em> to the same <span><i>file</i></span> in the same <span><i>element type</i></span> should work compatibly.</p>
|
|||
|
<p><strong>See Also:</strong></p>
|
|||
|
<p><span><b>with-open-file</b></span>, <span><b>close</b></span>, <span><b>pathname</b></span>, <span><b>logical-pathname</b></span>, Section 19.2.3 (Merging Pathnames), Section 19.1.2 (Pathnames as Filenames)</p>
|
|||
|
<p><strong>Notes:</strong></p>
|
|||
|
<p><span><b>open</b></span> does not automatically close the file when an abnormal exit occurs.</p>
|
|||
|
<p>When <em>element-type</em> is a <span><i>subtype</i></span> of <span><b>character</b></span>, <span><b>read-char</b></span> and/or <span><b>write-char</b></span> can be used on the resulting <span><i>file stream</i></span>.</p>
|
|||
|
<p>When <em>element-type</em> is a <span><i>subtype</i></span> of <em>integer</em> , <span><b>read-byte</b></span> and/or <span><b>write-byte</b></span> can be used on the resulting <span><i>file stream</i></span>.</p>
|
|||
|
<p>When <em>element-type</em> is <!-- -->:default<!-- -->, the <span><i>type</i></span> can be determined by using <span><b>stream-element-type</b></span>.</p>
|
|||
|
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="expanded-reference-open">Expanded Reference: open<a href="open_function.html#expanded-reference-open" class="hash-link" aria-label="Direct link to Expanded Reference: open" title="Direct link to Expanded Reference: open"></a></h2>
|
|||
|
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_BuS1"><p>TODO: Please contribute to this page by adding explanations and examples</p></div></div>
|
|||
|
<div class="language-lisp codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-lisp codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">(</span><span class="token car">open</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/lisp-docs/cl-language-reference/tree/main/docs/chap-21/cb-c-dictionary/open_function.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"><span class="theme-last-updated">Last updated<!-- --> by <b>daninus14</b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="open-stream-p_function.html"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">open-stream-p</div></a><a class="pagination-nav__link pagination-nav__link--next" href="peek-char_function.html"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">peek-char</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="open_function.html#expanded-reference-open" class="table-of-contents__link toc-highlight">Expanded Reference: open</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a href="../../../docs/tutorial.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Common Lisp Tutorial</a></li><li class="footer__item"><a href="../../index.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Common Lisp Technical Reference</a></li><li class="footer__item"><a href="../../../docs/help.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Help</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/common-lisp" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://discord.gg/hhk46CE" target="_blank" rel="noopener noreferrer" cla
|
|||
|
</body>
|
|||
|
</html>
|