IDataStore.GetItemStatus(int row, string column, DwBuffer dwbuffer = DwBuffer.Primary) Method

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

0.5.0-alpha

1.0.1 (current)

Gets the modification status of a column (specified by column name) 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, string column, DwBuffer dwbuffer = DwBuffer.Primary);

Parameters

row System.Int32

The zero-base row number to get status.

column System.String

The name of a column to get status.

To get the contents of a computed field, specify the name of the computed field for column. Computed fields do not have numbers.

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

Use 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 name).

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 Example2()
        {

            // 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(
                "Department ID Status: {0};\n" +
                "Department Name Status: {1}",
                datastore.GetItemStatus(0, "departmentid"),
                datastore.GetItemStatus(0, "name", DwBuffer.Primary));

            /*This code produces the following output:
           
            Department ID Status: NotModified;
            Department Name Status: Modified
            */
        }
    }
}

Applies to

.NET Standard

2.x