IDataStore.GetItemStatus(int row, short column, DwBuffer bufferType = DwBuffer.Primary) Method

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

0.5.0-alpha

1.0.1 (current)

Reports the modification status of a column (specified by column number) within a row in the specified buffer. The modification status determines the type of SQL statement the Update method will generate for the row or column.

Namespace: PowerBuilder.Data

Assembly: PowerBuilder.Data.dll

Syntax

  public PropertyState GetItemStatus(int row, short column, DwBuffer dwbuffer = DwBuffer.Primary);

Parameters

row System.Int32

The zero-based row number to get status.

column System.Int16

The zero-based column number to get status.

bufferType PowerBuilder.Data.DwBuffer

The specified buffer of the DataStore. The default is DwBuffer.Primary.

Returns

SnapObjects.Data.PropertyState

A value of the PropertyState enumerated datatype.

Remarks

Uses the GetRowStatus method and the GetItemStatus method to understand what SQL statements will be generated for the new and changed information when you update the database.

For rows in the primary and filter buffers, Update generates an INSERT statement for rows with ModelState.NewModified status; and generates an UPDATE statement for rows with ModelState.Modified status and references the columns that have been affected.

For rows in the delete buffer, Update does not generate a DELETE statement for rows whose status was ModelState.New or ModelState.NewModified before being moved to the delete buffer.

Examples

The following code example demonstrates how to get the status of a column (specified by the column number).

using PowerBuilder.Data;
using System;

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

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

        public void Example1()
        {
            // Instantiates a DataStore object with datawindow: d_department.
            var datastore = new DataStore("d_department", _context);

            datastore.Retrieve();

            datastore.SetItem(0, "name", "Department Name");

            Console.WriteLine(
                "Column 0 Status: {0};\n" +
                "Column 1 Status: {1}",
                datastore.GetItemStatus(0, 0),
                datastore.GetItemStatus(0, 1, DwBuffer.Primary));

            /*This code produces the following output:
             
           Column 0 Status: NotModified;
           Column 1 Status: Modified
            */
        }
    }
}

Applies to

.NET Standard

2.x