RecordCapOverride property (WinStudio scripts)

Applies To

IWSIDOCollection interface

Definition

Sets or returns a value indicating the current record cap.

Set Syntax

object.RecordCapOverride = Integer


Part	Description
`object`	Required. A reference to a valid IDO collection object.
`Integer`	Required. An integer value that determines what the record cap is to be set to.

Get Syntax

object.RecordCapOverride


Part	Description
`object`	Required. A reference to a valid IDO collection object.

Remarks

This property can be set to override the current record cap. This can allow you to temporarily reset the record cap and then set it back to the default, for example.

Note: When used in a script, this record cap override is not subject to any system-wide record cap settings.

Example

Sub Main()
   Dim oCache As IWSIDOCollection
   
   oCache = ThisForm.CurrentIDOCollection
   Application.ShowMessage("The current record cap is " & oCache.RecordCapOverride & ".")
   If oCache.RecordCapOverride = -1 Then
      oCache.RecordCapOverride = 500
   Else
      oCache.RecordCapOverride = -1
   End If
   Application.ShowMessage("The record cap is now " & oCache.RecordCapOverride & ".")
End Sub