GetEventProperty gets the specified event property, given an event id and an event property name.
It can also return an array of properties. In this case, a concatonation of event properties is
needed. IE: "property1+propery2" would return an array of properties containing property1 and property2.
Namespace:
GrassValley.Mseries.ScheduleEditorAssembly: GrassValley.Mseries.ScheduleEditor (in GrassValley.Mseries.ScheduleEditor.dll) Version: 1.0.0.0
Syntax
C# |
---|
public Object GetEventProperty( string eventId, string propertyQuery ) |
Visual Basic (Declaration) |
---|
Public Function GetEventProperty ( _ eventId As String, _ propertyQuery As String _ ) As Object |
Visual C++ |
---|
public: virtual Object^ GetEventProperty( String^ eventId, String^ propertyQuery ) sealed |
Parameters
- eventId
- Type: System..::.String
The event id.
- propertyQuery
- Type: System..::.String
The property query.
Return Value
object or object arrayImplements
IScheduleEditor..::.GetEventProperty(String, String)Remarks
Following are the property names that can be included in the propertyQuery parameter:
- "name"
- "id"
- "eventtype"
- "eventtypestr"
- "uri"
- "starttype"
- "starttypestr"
- "parentid"
- "startdatestr"
- "starttimestr"
- "durationstr"
- "comment"
- "repeatmode"
- "repeatmodestr"
- "repeatdatestr"
- "repeattimestr"
- "repeatenddatestr"
- "repeatendtimestr"
- "purgedatestr"
- "purgetimestr"
- "purgecount"
- "error"
- "layer"
- "markinstr"
- "ismarkinabsolute"
- "alturi"
- "altmarkinstr"
- "isaltmarkinabsolute"
- "destinationuri"
- "username"
- "trafficid"
- "edituid"
- "laststartdatestr"
- "laststarttimestr"
- "lastdurationstr"
- "lasterror"
- "eventhandle"
- "completed"
- "childid"
Examples
CopyC#
//Call helper function CreateIScheduleEditor which creates editor object IScheduleEditor schEditor = CreateIScheduleEditor(); string eventID = "some previously inserted event ID"; string strPropertyQuery = "eventTypestr"; string result = (string)schEditor.GetEventProperty(eventID, strPropertyQuery); Console.WriteLine(result); //now request multiple properties strPropertyQuery = "eventTypestr+layer+starttimestr"; object[] results = (object[])schEditor.GetEventProperty(eventID, strPropertyQuery); foreach (object obj in results) { Console.WriteLine("obj = " + obj); }