<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SharedDevice Class — pysmb 1.2.7 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="SharedFile Class" href="smb_SharedFile.html" />
<link rel="prev" title="SMBProtocolFactory Class" href="smb_SMBProtocolFactory.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="smb_SharedFile.html" title="SharedFile Class"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="smb_SMBProtocolFactory.html" title="SMBProtocolFactory Class"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">SharedDevice Class</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="shareddevice-class">
<h1>SharedDevice Class<a class="headerlink" href="#shareddevice-class" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="smb.base.SharedDevice">
<em class="property">class </em><code class="sig-prename descclassname">smb.base.</code><code class="sig-name descname">SharedDevice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">comments</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/base.html#SharedDevice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.SharedDevice" title="Permalink to this definition">¶</a></dt>
<dd><p>Contains information about a single shared device on the remote server.</p>
<p>The following attributes are available:</p>
<ul class="simple">
<li><p>name : An unicode string containing the name of the shared device</p></li>
<li><p>comments : An unicode string containing the user description of the shared device</p></li>
</ul>
<dl class="py attribute">
<dt id="smb.base.SharedDevice.comments">
<code class="sig-name descname">comments</code><a class="headerlink" href="#smb.base.SharedDevice.comments" title="Permalink to this definition">¶</a></dt>
<dd><p>An unicode string containing the user description of the shared device</p>
</dd></dl>
<dl class="py method">
<dt id="smb.base.SharedDevice.isSpecial">
<em class="property">property </em><code class="sig-name descname">isSpecial</code><a class="headerlink" href="#smb.base.SharedDevice.isSpecial" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if this shared device is a special share reserved for interprocess communication (IPC$)
or remote administration of the server (ADMIN$). Can also refer to administrative shares such as
C$, D$, E$, and so forth</p>
</dd></dl>
<dl class="py method">
<dt id="smb.base.SharedDevice.isTemporary">
<em class="property">property </em><code class="sig-name descname">isTemporary</code><a class="headerlink" href="#smb.base.SharedDevice.isTemporary" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if this is a temporary share that is not persisted for creation each time the file server initializes.</p>
</dd></dl>
<dl class="py attribute">
<dt id="smb.base.SharedDevice.name">
<code class="sig-name descname">name</code><a class="headerlink" href="#smb.base.SharedDevice.name" title="Permalink to this definition">¶</a></dt>
<dd><p>An unicode string containing the name of the shared device</p>
</dd></dl>
<dl class="py method">
<dt id="smb.base.SharedDevice.type">
<em class="property">property </em><code class="sig-name descname">type</code><a class="headerlink" href="#smb.base.SharedDevice.type" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>Returns one of the following integral constants.</dt><dd><ul class="simple">
<li><p>SharedDevice.DISK_TREE</p></li>
<li><p>SharedDevice.PRINT_QUEUE</p></li>
<li><p>SharedDevice.COMM_DEVICE</p></li>
<li><p>SharedDevice.IPC</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="smb_SMBProtocolFactory.html"
title="previous chapter">SMBProtocolFactory Class</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="smb_SharedFile.html"
title="next chapter">SharedFile Class</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/smb_SharedDevice.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="smb_SharedFile.html" title="SharedFile Class"
>next</a> |</li>
<li class="right" >
<a href="smb_SMBProtocolFactory.html" title="SMBProtocolFactory Class"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">SharedDevice Class</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2001-2021, Michael Teo https://miketeo.net/.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3.
</div>
</body>
</html>