GetItemDate – PB Docs 150

GetItemDate method (DataWindows)

Description

Gets data whose type is Date 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.

note.png Separate method names for the Web DataWindow server
component

Separate method names, GetItemDateByColNum, GetItemDateByColNumEx,
and GetItemDateEx, are provided as alternative syntaxes
for the Web DataWindow server component, which cannot use overloaded
methods.

Controls

DataWindow type

Method applies to

PowerBuilder

DataWindow control, DataWindowChild object, DataStore
object

Web

Server component

Web ActiveX

DataWindow control, DataWindowChild object

Syntax

[PowerBuilder]

[Web DataWindow server component]

[Web ActiveX]

Argument

Description

dwcontrol

A reference to a DataWindow control,
DataStore, or child DataWindow.

row

A value identifying the row location
of the data.

column

The column location of the data. The
datatype of the column must be date. 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 (the values initially retrieved from the database).

  • False – (Default) Returns
    the current values.

If you specify dwbuffer, you must also
specify originalvalue.

Return Values

Returns the date 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
if any other error occurs.

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

Usage

Use GetItemDate 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.

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

note.png Datatypes of columns and computed fields

There is a difference in datatypes between columns and computed columns
retrieved from the database and computed fields defined in the DataWindow
painter. Computed columns from the database can have a datatype
of date, but a date computed field always has a datatype of DateTime,
not date. In PowerBuilder, use the GetItemDateTime method instead.

note.png Web ActiveX only: columns involving dates

Use GetItemDate for all columns of type
date, DateTime, and time.

note.png PowerBuilder only: using GetItemDate in a String function

When you call GetItemDate as an argument
for the String function and do not specify a
display format, the value is formatted as a DateTime value. This
statement returns a string like “2/26/96 00:00:00”:

To get a simple date string, you can specify a display format:

or you can assign the date to a date variable before calling
the String function:

Examples

These statements set hiredate to the current Date
data in the third row of the primary buffer in the column named
first_day of dw_employee:

These statements set hiredate to the current Date
data in the third row of the filter buffer in the column named first_day
of dw_employee:

These statements set hiredate to original Date data
in the third row of the primary buffer in the column named hdate
of dw_employee:

See Also


Document get from Powerbuilder help
Thank you for watching.
Was this article helpful?
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x