Share via


Preferences.ExportNode(Stream) Method

Definition

Emits on the specified output stream an XML document representing all of the preferences contained in this node (but not its descendants).

[Android.Runtime.Register("exportNode", "(Ljava/io/OutputStream;)V", "GetExportNode_Ljava_io_OutputStream_Handler")]
public abstract void ExportNode (System.IO.Stream? os);
[<Android.Runtime.Register("exportNode", "(Ljava/io/OutputStream;)V", "GetExportNode_Ljava_io_OutputStream_Handler")>]
abstract member ExportNode : System.IO.Stream -> unit

Parameters

os
Stream

the output stream on which to emit the XML document.

Attributes

Exceptions

if an error occurs while exporting.

if the backing store is unavailable or causes an operation failure.

if this node has been removed.

Remarks

Emits on the specified output stream an XML document representing all of the preferences contained in this node (but not its descendants). This XML document is, in effect, an offline backup of the node.

The XML document will have the following DOCTYPE declaration:

{@code
<!DOCTYPE preferences SYSTEM "http://java.sun.com/dtd/preferences.dtd">
            }

The UTF-8 character encoding will be used.

This method is an exception to the general rule that the results of concurrently executing multiple methods in this class yields results equivalent to some serial execution. If the preferences at this node are modified concurrently with an invocation of this method, the exported preferences comprise a "fuzzy snapshot" of the preferences contained in the node; some of the concurrent modifications may be reflected in the exported data while others may not.

Java documentation for java.util.prefs.Preferences.exportNode(java.io.OutputStream).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to