aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/win32reg.xml
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2011-05-06 15:58:09 +0200
committerHans Bolinder <[email protected]>2011-05-12 08:03:42 +0200
commit229d0d8ca88bc344bed89e46541b325c1d267996 (patch)
tree74fec344df8596c868c36cec5ac08102008cacf3 /lib/stdlib/doc/src/win32reg.xml
parent68fe6a14539b82250373ef114d6576e74e1b8f2e (diff)
downloadotp-229d0d8ca88bc344bed89e46541b325c1d267996.tar.gz
otp-229d0d8ca88bc344bed89e46541b325c1d267996.tar.bz2
otp-229d0d8ca88bc344bed89e46541b325c1d267996.zip
r
Use Erlang specs and types for documentation
Diffstat (limited to 'lib/stdlib/doc/src/win32reg.xml')
-rw-r--r--lib/stdlib/doc/src/win32reg.xml98
1 files changed, 27 insertions, 71 deletions
diff --git a/lib/stdlib/doc/src/win32reg.xml b/lib/stdlib/doc/src/win32reg.xml
index 28960cd098..99fd7fdeb6 100644
--- a/lib/stdlib/doc/src/win32reg.xml
+++ b/lib/stdlib/doc/src/win32reg.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>2000</year><year>2009</year>
+ <year>2000</year><year>2011</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -85,14 +85,22 @@ hkdd HKEY_DYN_DATA</pre>
<p>For additional information on the Windows registry consult the Win32
Programmer's Reference.</p>
</description>
+ <datatypes>
+ <datatype>
+ <name name="reg_handle"/>
+ <desc><p>As returned by <seealso marker="#open/1">open/1</seealso>.</p></desc>
+ </datatype>
+ <datatype>
+ <name name="name"/>
+ </datatype>
+ <datatype>
+ <name name="value"/>
+ </datatype>
+ </datatypes>
<funcs>
<func>
- <name>change_key(RegHandle, Key) -> ReturnValue</name>
+ <name name="change_key" arity="2"/>
<fsummary>Move to a key in the registry</fsummary>
- <type>
- <v>RegHandle = term()</v>
- <v>Key = string()</v>
- </type>
<desc>
<p>Changes the current key to another key. Works like cd.
The key can be specified as a relative path or as an
@@ -100,12 +108,8 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>change_key_create(RegHandle, Key) -> ReturnValue</name>
+ <name name="change_key_create" arity="2"/>
<fsummary>Move to a key, create it if it is not there</fsummary>
- <type>
- <v>RegHandle = term()</v>
- <v>Key = string()</v>
- </type>
<desc>
<p>Creates a key, or just changes to it, if it is already there. Works
like a combination of <c>mkdir</c> and <c>cd</c>. Calls the Win32 API function
@@ -114,23 +118,16 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>close(RegHandle)-> ReturnValue</name>
+ <name name="close" arity="1"/>
<fsummary>Close the registry.</fsummary>
- <type>
- <v>RegHandle = term()</v>
- </type>
<desc>
- <p>Closes the registry. After that, the <c>RegHandle</c> cannot
+ <p>Closes the registry. After that, the <c><anno>RegHandle</anno></c> cannot
be used.</p>
</desc>
</func>
<func>
- <name>current_key(RegHandle) -> ReturnValue</name>
+ <name name="current_key" arity="1"/>
<fsummary>Return the path to the current key.</fsummary>
- <type>
- <v>RegHandle = term()</v>
- <v>ReturnValue = {ok, string()}</v>
- </type>
<desc>
<p>Returns the path to the current key. This is the equivalent of <c>pwd</c>.</p>
<p>Note that the current key is stored in the driver, and might be
@@ -138,12 +135,8 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>delete_key(RegHandle) -> ReturnValue</name>
+ <name name="delete_key" arity="1"/>
<fsummary>Delete the current key</fsummary>
- <type>
- <v>RegHandle = term()</v>
- <v>ReturnValue = ok | {error, ErrorId}</v>
- </type>
<desc>
<p>Deletes the current key, if it is valid. Calls the Win32 API
function <c>RegDeleteKey()</c>. Note that this call does not change the current key,
@@ -152,12 +145,8 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>delete_value(RegHandle, Name) -> ReturnValue</name>
+ <name name="delete_value" arity="2"/>
<fsummary>Delete the named value on the current key.</fsummary>
- <type>
- <v>RegHandle = term()</v>
- <v>ReturnValue = ok | {error, ErrorId}</v>
- </type>
<desc>
<p>Deletes a named value on the current key. The atom <c>default</c> is
used for the the default value.</p>
@@ -165,12 +154,8 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>expand(String) -> ExpandedString</name>
+ <name name="expand" arity="1"/>
<fsummary>Expand a string with environment variables</fsummary>
- <type>
- <v>String = string()</v>
- <v>ExpandedString = string()</v>
- </type>
<desc>
<p>Expands a string containing environment variables between percent
characters. Anything between two % is taken for a environment
@@ -180,23 +165,15 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>format_error(ErrorId) -> ErrorString</name>
+ <name name="format_error" arity="1"/>
<fsummary>Convert an POSIX errorcode to a string</fsummary>
- <type>
- <v>ErrorId = atom()</v>
- <v>ErrorString = string()</v>
- </type>
<desc>
<p>Convert an POSIX errorcode to a string (by calling <c>erl_posix_msg:message</c>).</p>
</desc>
</func>
<func>
- <name>open(OpenModeList)-> ReturnValue</name>
+ <name name="open" arity="1"/>
<fsummary>Open the registry for reading or writing</fsummary>
- <type>
- <v>OpenModeList = [OpenMode]</v>
- <v>OpenMode = read | write</v>
- </type>
<desc>
<p>Opens the registry for reading or writing. The current key will be the root
(<c>HKEY_CLASSES_ROOT</c>). The <c>read</c> flag in the mode list can be omitted.</p>
@@ -204,12 +181,8 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>set_value(RegHandle, Name, Value) -> ReturnValue</name>
+ <name name="set_value" arity="3"/>
<fsummary>Set value at the current registry key with specified name.</fsummary>
- <type>
- <v>Name = string() | default</v>
- <v>Value = string() | integer() | binary()</v>
- </type>
<desc>
<p>Sets the named (or default) value to value. Calls the Win32
API function <c>RegSetValueEx()</c>. The value can be of three types, and
@@ -221,13 +194,8 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>sub_keys(RegHandle) -> ReturnValue</name>
+ <name name="sub_keys" arity="1"/>
<fsummary>Get subkeys to the current key.</fsummary>
- <type>
- <v>ReturnValue = {ok, SubKeys} | {error, ErrorId}</v>
- <v>SubKeys = [SubKey]</v>
- <v>SubKey = string()</v>
- </type>
<desc>
<p>Returns a list of subkeys to the current key. Calls the Win32
API function <c>EnumRegKeysEx()</c>.</p>
@@ -235,13 +203,8 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>value(RegHandle, Name) -> ReturnValue</name>
+ <name name="value" arity="2"/>
<fsummary>Get the named value on the current key.</fsummary>
- <type>
- <v>Name = string() | default</v>
- <v>ReturnValue = {ok, Value}</v>
- <v>Value = string() | integer() | binary()</v>
- </type>
<desc>
<p>Retrieves the named value (or default) on the current key.
Registry values of type <c>REG_SZ</c>, are returned as strings. Type <c>REG_DWORD</c>
@@ -249,15 +212,8 @@ hkdd HKEY_DYN_DATA</pre>
</desc>
</func>
<func>
- <name>values(RegHandle) -> ReturnValue</name>
+ <name name="values" arity="1"/>
<fsummary>Get all values on the current key.</fsummary>
- <type>
- <v>ReturnValue = {ok, ValuePairs} | {ok, ErrorId}</v>
- <v>ValuePairs = [ValuePair]</v>
- <v>ValuePair = {Name, Value}</v>
- <v>Name = string | default</v>
- <v>Value = string() | integer() | binary()</v>
- </type>
<desc>
<p>Retrieves a list of all values on the current key. The values
have types corresponding to the registry types, see <c>value</c>.