GetItemDateTime

Description

Gets data whose type is DateTime from the specified buffer of a DataWindow control or DataStore object. You can obtain the data that was originally retrieved and stored in the database from the original buffer, as well as the current value in the primary, delete, or filter buffers.

Applies to

DataWindow type

Method applies to

PowerBuilder

DataWindow control, DataWindowChild object, DataStore object


Syntax

PowerBuilder

DateTime dwcontrol.GetItemDateTime ( long row, string column 
   {, DWBuffer dwbuffer, boolean originalvalue } )
DateTime dwcontrol.GetItemDateTime ( long row, integer column
   {, DWBuffer dwbuffer, boolean originalvalue } )

Argument

Description

dwcontrol

A reference to the DataWindow control, DataStore, or child DataWindow in which you want to obtain the DateTime data contained in a specific row and column.

row

A value identifying the row location of the data.

column

The column location of the data. The datatype of the column must be DateTime. Column can be a column number or a column name. The column number is the number of the column as it is listed in the Column Specification view of the DataWindow painter -- not necessarily the number of the column in the Design view.

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

dwbuffer (optional)

A value identifying the DataWindow buffer from which you want to get the data.

For a list of valid values, see DWBuffer.

originalvalue (optional)

A boolean indicating whether you want the original or current values for row and column:

  • True -- Returns the original values, that is, the values initially retrieved from the database.

  • False -- (Default) Returns the current values.

If you specify dwbuffer, you must also specify originalvalue.


Return value

Returns the DateTime or Timestamp value in the specified row and column. Returns null if the column value is null or if there is no DataWindow object assigned to the DataWindow control or DataStore. Returns 1900-01-01 00:00:00.000000 if any other error occurs.

If any argument value is null, in PowerBuilder the method returns null.

Usage

Use GetItemDateTime when you want to get information from the DataWindow's buffers. To find out what the user entered in the current column before that data is accepted, use GetText. In the ItemChanged or ItemError events, use the data argument.

To access a row in the original buffer, specify the buffer that the row currently occupies (primary, delete, or filter) and the number of the row in that buffer. When you specify true for originalvalue, the method gets the original data for that row from the original buffer.

Datatype mismatch

An execution error occurs when the datatype of the DataWindow column does not match the datatype of the method -- in this case, DateTime.

Computed fields displaying date or time values have a datatype of DateTime, not date or time. Always use GetItemDateTime to get their value, not GetItemDate or GetItemTime.

Examples

These statements set as_of to the current DateTime data in the primary buffer for row 3 of the column named start_dt in the DataWindow dw_emp:

DateTime as_of
as_of = dw_emp.GetItemDateTime(3, "start_dt")

These statements set as_of to the current DateTime data in the delete buffer for row 3 of the end_dt column of dw_emp:

DateTime as_of
as_of = dw_emp.GetItemDateTime(3, "end_dt", &
      Delete!, false)

These statements set AsOf to the original DateTime data in the primary buffer for row 3 of the end_dt column of dw_emp:

DateTime as_of
as_of = dw_emp.GetItemDateTime(3, "end_dt", &
      Primary!, true)

See also

GetItemDate

GetItemDecimal

GetItemNumber

GetItemString

GetItemTime

SetItem