IDataStore.ExportJson(DwBuffer dwbuffer, bool changedOnly, MappingMethod mappingMethod) Method

.NET Standard 2.x | Current Version (1.0.1)

0.5.0-alpha

1.0.1 (current)

Exports all rows or only the changed rows from all or specified buffers to a DataWindow JSON string.

Namespace: PowerBuilder.Data

Assembly: PowerBuilder.Data.dll

Syntax

  public string ExportJson(DwBuffer dwbuffer, bool changedOnly, MappingMethod mappingMethod);

Parameters

dwbuffer PowerBuilder.Data.DwBuffer

A value of the DwBuffer enumerated datatype identifying the DataWindow buffer from which you want to export the data. For a list of valid values, see DWBuffer. If not specified, all of the DataWindow buffers will be exported, however, the data for DataWindowChild will not be exported (even if changedonly parameter is false).

changeOnly System.Boolean

A Boolean specifying the changing flag.

True -- to export the changed rows only (and all rows in the delete buffer).

False (default) -- to export all rows.

mappingMethod SnapObjects.Data.MappingMethod

A value of the MappingMethod enumerated datatype specifying the method for mapping columns.

Returns

System.String

Returns the JSON string if it succeeds.

Examples

The following code example demonstrates how to export the department records from the primary buffer to JSON strings using different changeOnly arguments. When changeOnly is true, exports the modified data from the primary buffer to a JSON string; when changeOnly is false, exports all data from the primary buffer to a JSON string.

using SnapObjects.Data;
using PowerBuilder.Data;
using System;

namespace Appeon.ApiDoc.IDataStoreExamples
{
    public class ExportJsonExample
    {
        private SchoolContext _context;

        public ExportJsonExample(SchoolContext dataContext)
        {
            // Sets the data context
            _context = dataContext;
        }

        public void Example3()
        {
            // Instantiates the datastore with datawindow: d_department
            var datastore = new DataStore("d_department", _context);

            // Generates data in the primary/delete/filter buffers for this example.
            datastore.Retrieve();
            datastore.DeleteRow(0);
            datastore.SetItem(0, 1, "department name");
            datastore.SetFilter("departmentid < 5");
            datastore.Filter();

            // Exports the modified data from the primary buffer
            string json1 =
                datastore.ExportJson(DwBuffer.Primary, true, MappingMethod.Index);


            Console.WriteLine("datastore.ExportJson(DwBuffer.Primary,true, 0):");
            Console.WriteLine(json1);

            /*The exported JSON file is:

            ExportJson3_1.json  
            */

            // Exports all data from the primary buffer
            string json2 =
                datastore.ExportJson(DwBuffer.Primary, false, MappingMethod.Index);

            Console.WriteLine("datastore.ExportJson(DwBuffer.Primary, false, 0):");
            Console.WriteLine(json2);

            /*The exported JSON file is:

            ExportJson3_2.json
            */
        }
    }
}

Example Refer To

JSON Files: ExportJson3_1 ExportJson3_2

Applies to

.NET Standard

2.x