ExportXml Method (CatalogExportOptions, Stream)

Article
11/12/2009

Exports catalogs to the specified stream.

Namespace: Microsoft.CommerceServer.Catalog
Assembly: Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)

Syntax

'Declaration
Public Function ExportXml ( _
    catalogExportOptions As CatalogExportOptions, _
    exportStream As Stream _
) As ExportProgress

'Usage
Dim instance As CatalogContext
Dim catalogExportOptions As CatalogExportOptions
Dim exportStream As Stream
Dim returnValue As ExportProgress

returnValue = instance.ExportXml(catalogExportOptions, _
    exportStream)

public ExportProgress ExportXml(
    CatalogExportOptions catalogExportOptions,
    Stream exportStream
)

public:
ExportProgress^ ExportXml(
    CatalogExportOptions^ catalogExportOptions, 
    Stream^ exportStream
)

public function ExportXml(
    catalogExportOptions : CatalogExportOptions, 
    exportStream : Stream
) : ExportProgress

Parameters

catalogExportOptions
Type: Microsoft.CommerceServer.Catalog..::.CatalogExportOptions
The catalog export options. Should not be nullNothingnullptra null reference (Nothing in Visual Basic).

exportStream
Type: System.IO..::.Stream
The export stream. Should not be nullNothingnullptra null reference (Nothing in Visual Basic).

Return Value

Type: Microsoft.CommerceServer.Catalog..::.ExportProgress
An ExportProgress object.

Exceptions

Exception	Condition
ArgumentNullException	The catalogExportOptions or exportStream is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

Use this method to export catalog data to a stream. Creates an XML steam that contains Catalog information. The exportStream virtual file contains set of options to use for a catalog export operation. The options consist if the exported catalog is a base or virtual catalog, the language of the exported catalog, an indicator to determine if the dependent base catalog should be exported along with the virtual catalog, and the catalog sets to export.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via