NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

HxLink DID NOT INITIALIZE

DatePart Function

Returns an Integer containing the specified part of a given date.

DatePart(dateinterval, date[,firstdayofweek[, firstweekofyear]])

The DatePart function syntax has these named arguments:

Arguments

dateinterval
Required. String expression that is the interval of time you want to return.
date
Required. DateTime value that you want to evaluate.
firstdayofweek
Optional. A constant that specifies the first day of the week. If not specified, Sunday is assumed.
firstweekofyear
Optional. A constant that specifies the first week of the year. If not specified, the first week is assumed to be the week in which January 1 occurs.

Settings

The dateinterval argument has these settings:

Setting Description
yyyy Year
q Quarter
m Month
y Day of year
d Day
w Weekday
ww Week
h Hour
n Minute
s Second

The firstdayofweek argument has these settings:

Constant Value Description
UseSystemDayofWeek 0 Use the day of the week specified in your system settings for the first day of the week
Sunday 1 Sunday (default)
Monday 2 Monday
Tuesday 3 Tuesday
Wednesday 4 Wednesday
Thursday 5 Thursday
Friday 6 Friday
Saturday 7 Saturday

The firstweekofyear argument has these settings:

Constant Value Description
UseSystemDayOfWeek 0 Use the day of the week specified in your system settings for the first day of the week
FirstJan1 1 Start with week in which January 1 occurs (default).
FirstFourDays 2 Start with the first week that has at least four days in the new year.
FirstFullWeek 3 Start with first full week of the year.

Remarks

You can use the DatePart function to evaluate a date and return a specific interval of time. For example, you might use DatePart to calculate the day of the week or the current hour.

The firstdayofweek argument affects calculations that use the "w" and "ww" interval symbols.

If date is a date literal, the specified year becomes a permanent part of that date. However, if date is enclosed in double quotation marks (" "), and you omit the year, the current year is inserted in your code each time the date expression is evaluated. This makes it possible to write code that can be used in different years.

Note For date, if the Calendar property setting is Gregorian, the supplied date must be Gregorian. If the calendar is Hijri, the supplied date must be Hijri.
The returned date part is in the time period units of the current Arabic calendar. For example, if the current calendar is Hijri and the date part to be returned is the year, the year value is a Hijri year.

See Also

Example

Calendar Property | DateAdd Function | DateDiff Function | Day Function | Format Function | Now Function | Weekday Function | Year Function