Description

Creates an event at fixed offset from specified reference event.

Syntax

[Visual Basic .NET]
Public Function CreateEventTimeOffset( _ ByVal Name As String, _ ByVal Description As String _ ) As

[Visual Basic .NET]

Public Function CreateEventTimeOffset( _
    ByVal Name As String, _
    ByVal Description As String _
) As

[C#]
public IAgCrdnEvent CreateEventTimeOffset( string Name, string Description );

[Managed C++]
public: IAgCrdnEvent^ CreateEventTimeOffset( String __gc ^ Name, String __gc ^ Description );

[Java]
public IAgCrdnEvent createEventTimeOffset( String Name, String Description );

[Unmanaged C++]
public: HRESULT CreateEventTimeOffset( BSTR Name, BSTR Description, IAgCrdnEvent ** ppRetVal );

[Unmanaged C++]

public: HRESULT CreateEventTimeOffset(
    BSTR Name,
    BSTR Description,
    IAgCrdnEvent ** ppRetVal
);

Parameters

Name
Description

Remarks

Spaces and most punctuation ( except for "-_().") cannot be used as a part of a component name when creating new components via VGT API.

Example

Create and configure fixed time offset event.

[C#]

IAgCrdnEvent timeEvent = provider.Events.Factory.CreateEventTimeOffset("MyEventTimeOffset", "MyDescription");
IAgCrdnEventTimeOffset asTimeOffset = timeEvent as IAgCrdnEventTimeOffset;

asTimeOffset.ReferenceTimeInstant = provider.Events["AvailabilityStartTime"];

// Uses current Time unit preference, this code snippet assumes seconds.
asTimeOffset.TimeOffset = 3;

IAgCrdnEventFindOccurrenceResult occurrence = timeEvent.FindOccurrence();
if (occurrence.IsValid)
{
    Console.WriteLine("Event occurred at: " + occurrence.Epoch);
}