/usr/lib/swi-prolog/doc/Manual/registry.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<HTML>
<HEAD>
<TITLE>SWI-Prolog 5.11.18 Reference Manual: Section A.22</TITLE><LINK REL=home HREF="index.html">
<LINK REL=contents HREF="Contents.html">
<LINK REL=index HREF="DocIndex.html">
<LINK REL=summary HREF="summary.html">
<LINK REL=previous HREF="record.html">
<LINK REL=next HREF="simplex.html">
<STYLE type="text/css">
/* Style sheet for SWI-Prolog latex2html
*/

dd.defbody
{ margin-bottom: 1em;
}

dt.pubdef
{ background-color: #c5e1ff;
}

dt.multidef
{ background-color: #c8ffc7;
}

.bib dd
{ margin-bottom: 1em;
}

.bib dt
{ float: left;
margin-right: 1.3ex;
}

pre.code
{ margin-left: 1.5em;
margin-right: 1.5em;
border: 1px dotted;
padding-top: 5px;
padding-left: 5px;
padding-bottom: 5px;
background-color: #f8f8f8;
}

div.navigate
{ text-align: center;
background-color: #f0f0f0;
border: 1px dotted;
padding: 5px;
}

div.title
{ text-align: center;
padding-bottom: 1em;
font-size: 200%;
font-weight: bold;
}

div.author
{ text-align: center;
font-style: italic;
}

div.abstract
{ margin-top: 2em;
background-color: #f0f0f0;
border: 1px dotted;
padding: 5px;
margin-left: 10%; margin-right:10%;
}

div.abstract-title
{ text-align: center;
padding: 5px;
font-size: 120%;
font-weight: bold;
}

div.toc-h1
{ font-size: 200%;
font-weight: bold;
}

div.toc-h2
{ font-size: 120%;
font-weight: bold;
margin-left: 2em;
}

div.toc-h3
{ font-size: 100%;
font-weight: bold;
margin-left: 4em;
}

div.toc-h4
{ font-size: 100%;
margin-left: 6em;
}

span.sec-nr
{
}

span.sec-title
{
}

span.pred-ext
{ font-weight: bold;
}

span.pred-tag
{ float: right;
padding-top: 0.2em;
font-size: 80%;
font-style: italic;
color: #202020;
}

/* Footnotes */

sup.fn { color: blue; text-decoration: underline; }
span.fn-text { display: none; }
sup.fn span {display: none;}
sup:hover span
{ display: block !important;
position: absolute; top: auto; left: auto; width: 80%;
color: #000; background: white;
border: 2px solid;
padding: 5px; margin: 10px; z-index: 100;
font-size: smaller;
}
</STYLE>
</HEAD>
<BODY BGCOLOR="white">
<DIV class="navigate"><A class="nav" href="index.html"><IMG SRC="home.gif" BORDER=0 ALT="Home"></A>
<A class="nav" href="Contents.html"><IMG SRC="index.gif" BORDER=0 ALT="Contents"></A>
<A class="nav" href="DocIndex.html"><IMG SRC="yellow_pages.gif" BORDER=0 ALT="Index"></A>
<A class="nav" href="summary.html"><IMG SRC="info.gif" BORDER=0 ALT="Summary"></A>
<A class="nav" href="record.html"><IMG SRC="prev.gif" BORDER=0 ALT="Previous"></A>
<A class="nav" href="simplex.html"><IMG SRC="next.gif" BORDER=0 ALT="Next"></A>
</DIV>

<H2><A NAME="sec:A.22"><SPAN class="sec-nr">A.22</SPAN> <SPAN class="sec-title">library(registry): 
Manipulating the Windows registry</SPAN></A></H2>

<A NAME="registry"></A>

<P>The <CODE>library(registry)</CODE> is only available on the 
MS-Windows version of SWI-Prolog. It loads the foreign extension <CODE>plregtry.dll</CODE>, 
providing the predicates described below. This library only makes the 
most common operations on the registry available through the Prolog 
user. The underlying DLL provides a more complete coverage of the 
Windows registry API. Please consult the sources in
<CODE>pl/src/win32/foreign/plregtry.c</CODE> for further details.

<P>In all these predicates, <VAR>Path</VAR> refers to a `/' separated 
path into the registry. This is <EM>not</EM> an atom containing 
`/'-characters as used for filenames, but a term using the functor <CODE><CODE>/</CODE>/2</CODE>. 
Windows defines the following roots for the registry:
<CODE>classes_root</CODE>,
<CODE>current_user</CODE>,
<CODE>local_machine</CODE> and
<CODE>users</CODE>

<DL class="latex">
<DT class="pubdef"><A NAME="registry_get_key/2"><STRONG>registry_get_key</STRONG>(<VAR>+Path, 
-Value</VAR>)</A></DT>
<DD class="defbody">
Get the principal (default) value associated to this key. Fails silently 
of the key does not exist.</DD>
<DT class="pubdef"><A NAME="registry_get_key/3"><STRONG>registry_get_key</STRONG>(<VAR>+Path, 
+Name, -Value</VAR>)</A></DT>
<DD class="defbody">
Get a named value associated to this key.</DD>
<DT class="pubdef"><A NAME="registry_set_key/2"><STRONG>registry_set_key</STRONG>(<VAR>+Path, 
+Value</VAR>)</A></DT>
<DD class="defbody">
Set the principal (default) value of this key. Creates (a path to) the 
key if this does not already exist.</DD>
<DT class="pubdef"><A NAME="registry_set_key/3"><STRONG>registry_set_key</STRONG>(<VAR>+Path, 
+Name, +Value</VAR>)</A></DT>
<DD class="defbody">
Associated a named value to this key. Creates (a path to) the key if 
this does not already exist.</DD>
<DT class="pubdef"><A NAME="registry_delete_key/1"><STRONG>registry_delete_key</STRONG>(<VAR>+Path</VAR>)</A></DT>
<DD class="defbody">
Delete the indicated key.</DD>
<DT class="pubdef"><A NAME="shell_register_file_type/4"><STRONG>shell_register_file_type</STRONG>(<VAR>+Ext, 
+Type, +Name, +OpenAction</VAR>)</A></DT>
<DD class="defbody">
Register a file-type. <VAR>Ext</VAR> is the extension to associate.
<VAR>Type</VAR> is the type name, often something link <CODE>prolog.type</CODE>.
<VAR>Name</VAR> is the name visible in the Windows file-type browser. 
Finally, <VAR>OpenAction</VAR> defines the action to execute when a file 
with this extension is opened in the Windows explorer.</DD>
<DT class="pubdef"><A NAME="shell_register_dde/6"><STRONG>shell_register_dde</STRONG>(<VAR>+Type, 
+Action, +Service, +Topic, +Command, +IfNotRunning</VAR>)</A></DT>
<DD class="defbody">
Associate DDE actions to a type. <VAR>Type</VAR> is the same type as 
used for the 2nd argument of <A NAME="idx:shellregisterfiletype4:1624"></A><A class="pred" href="registry.html#shell_register_file_type/4">shell_register_file_type/4</A>, <VAR>Action</VAR> 
is the a action to perform, <VAR>Service</VAR> and <VAR>Topic</VAR> 
specify the DDE topic to address and <VAR>Command</VAR> is the command 
to execute on this topic. Finally, <VAR>IfNotRunning</VAR> defines the 
command to execute if the required DDE server is not present.</DD>
<DT class="pubdef"><A NAME="shell_register_prolog/1"><STRONG>shell_register_prolog</STRONG>(<VAR>+Ext</VAR>)</A></DT>
<DD class="defbody">
Default registration of SWI-Prolog, which is invoked as part of the 
initialisation process on Windows systems. As the source also explains 
the above predicates, it is given as an example:

<PRE class="code">
shell_register_prolog(Ext) :-
        current_prolog_flag(argv, [Me|_]),
        concat_atom(['"', Me, '" "%1"'], OpenCommand),
        shell_register_file_type(Ext, 'prolog.type', 'Prolog Source',
                                 OpenCommand),
        shell_register_dde('prolog.type', consult,
                           prolog, control, 'consult(''%1'')', Me), 
        shell_register_dde('prolog.type', edit,
                           prolog, control, 'edit(''%1'')', Me).
</PRE>

<P></DD>
</DL>

</BODY></HTML>
swi-prolog-nox 5.10.4-3ubuntu1 / usr / lib / swi-prolog / doc / Manual / registry.html
