DSSnapshotDate Class

DSWS API (.NET)

[This is preliminary documentation and is subject to change.]

Defines the snapshot date

Inheritance Hierarchy

System Object
Datastream.DswsApi DSDateBase
Datastream.DswsApi DSSnapshotDate

Namespace: Datastream.DswsApi
Assembly: Datastream.DswsApi.NET4.0 (in Datastream.DswsApi.NET4.0.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy to Clipboard Print

public sealed class DSSnapshotDate : DSDateBase

public sealed class DSSnapshotDate : DSDateBase

Public NotInheritable Class DSSnapshotDate _
	Inherits DSDateBase

Public NotInheritable Class DSSnapshotDate _
	Inherits DSDateBase

Remarks

A snapshot date used in a DSDataRequest specifies the point in time for which the data must be retrieved. The date can be specified in absolute, relative or as string literal. You can use Absolute(DateTime) to construct an absolute date, Relative(Int32) to construct a relative date, or DSDateLiterals for specifying reserved date literals.

Examples

Following example shows the different types of date that can be created

C++

Copy to Clipboard Print

// An absolute date 
var date1 = new DSSnapshotDate(DSDateType.Absolute(DateTime.Now));

// A relative date 
var date2 = new DSSnapshotDate(DSDateType.Relative(-20));

// A relative date with frequency 
var date3 = new DSSnapshotDate(DSDateType.Relative(-20, DSDateFrequency.Monthly));

// A literal date 
var date4 = new DSSnapshotDate(DSDateType.Literal(DSDateLiterals.StartDateOfQuarter));

// Dont specify date 
var date5 = new DSSnapshotDate(null);

// An absolute date 
var date1 = new DSSnapshotDate(DSDateType.Absolute(DateTime.Now));

// A relative date 
var date2 = new DSSnapshotDate(DSDateType.Relative(-20));

// A relative date with frequency 
var date3 = new DSSnapshotDate(DSDateType.Relative(-20, DSDateFrequency.Monthly));

// A literal date 
var date4 = new DSSnapshotDate(DSDateType.Literal(DSDateLiterals.StartDateOfQuarter));

// Dont specify date 
var date5 = new DSSnapshotDate(null);

Version Information

.NET API Framework

Supported in: 4.1, 3.6