ViewScheduleGetScheduleInstances Method

public IList<ElementId> GetScheduleInstances(
	int segmentIndex
)

Public Function GetScheduleInstances ( 
	segmentIndex As Integer
) As IList(Of ElementId)

public:
IList<ElementId^>^ GetScheduleInstances(
	int segmentIndex
)

member GetScheduleInstances : 
        segmentIndex : int -> IList<ElementId> 

Parameters

segmentIndex  Int32

Index of the segment.

Return Value

The segment index value could be -1, it means to get schedule instances for the entire schedule.

When a (primary) schedule is set to filter by sheet and placed on a sheet, it will create a new schedule with elements visible in the Viewport(s) on that sheet. The instance created belongs to the newly created schedule. Calls to GetScheduleInstances() will return instances of the newly created schedule but no instances of the primary schedule.

Reference