system.date.midnight

This function is used in Python Scripting.

Description

Returns a copy of a date with the hour, minute, second, and millisecond fields set to zero.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.date.midnight(date)

Parameters

Type	Parameter	Description
Date	date	The starting date.

Returns

Date - A new date, set to midnight of the day provided

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Code Snippet

# This example prints out the current date with the time set to midnight.
  
date = system.date.now()
print system.date.midnight(date)