IReplicaFilterDescription.TableUsesDefQuery Property

Indicates if a definition query will be used when checking out a dataset.

[Visual Basic .NET]
Public Function get_TableUsesDefQuery ( _
    ByVal Index As Integer _
) As Boolean

[C#]
public bool get_TableUsesDefQuery (
    int Index
);

[C++]
HRESULT get_TableUsesDefQuery(
  long Index,
  VARIANT_BOOL* useDefinition
);

[C++]
Parameters
Index [in]
  Index is a parameter of type long
useDefinition [out, retval]
  useDefinition is a parameter of type VARIANT_BOOL

Product Availability

Remarks

A where clause can be applied to a specific dataset during a check out or an extraction using the IReplicaFilterDescriptionEdit::TableDefQuery property. If IReplicaFilterDescriptionEdit::TableDefQuery is set, the where clause is applied by default. The where clause can be ignored by setting IReplicaFilterDescriptionEdit::TableUsesDefQuery to false.

This property returns false if the where clause is set to be ignored during check out or extract. This property is very useful when writing custom applications which allow the user to control check outs and extractions.

The IReplicaDescription::FindTable method can be used to return the index of a specific dataset. The IReplicaDescription::TableName and IReplicaDescription::TableNameCount properties can be used to cycle through all checked out datasets. 

See Also