FUNCTIONUnder review

DBClearIndex

DBClearIndex() --> Nil

Closes indexes in the current work area.

DBClearIndexAdvPL

01 · OVERVIEW

Overview

DBClearIndex closes the area’s indexes and flushes pending updates according to the reference. It deletes no table and is not rollback. Subsequent indexed lookup requires reopening and selecting an appropriate order; do not assume the old order remains active. EDTRB identifies only an owned test table already open with the required schema and permissions; examples are not intended for standard tables. (TOTVS, n.d., ref. 1)

02 · SYNTAX

Syntax

DBClearIndex() --> Nil

Return value

Nil; not a logical success indicator.

03 · PRACTICAL EXAMPLE

Commented example

#Include "Protheus.ch"

User Function Ed324()
    // Only within the test table index context.
    If Select("EDTRB") > 0
        EDTRB->(DBClearIndex())
    EndIf
Return Nil

Expected result

Indexes closed on the test table; pending operations may be flushed. Under review: editorial example neither compiled nor run in Protheus. Check includes, release, RDD and context before testing.

BEST PRACTICES

Check RDD, alias and pending operations. Navigation can flush updates; preserve context under the caller contract and handle errors in the complete routine.
Under review: editorial example neither compiled nor run in Protheus. Check includes, release, RDD and context before testing.

DBClearIndex

Overview

Syntax

Return value

Commented example

Related content

Comments