Share via

BeforeDelete Event

  • Article

Occurs immediately before a delete command for a record executes.

Note   If batch updating is used, that is, the CursorAdapterBatchUpdateCount property is greater than 1, BeforeDelete does not occur.

PROCEDURE Object.BeforeDelete 
LPARAMETERS cFldState, lForce, cDeleteCmd

Parameters

  • cFldState
    Specifies the field states of the row being processed. This is the same value as obtained from calling the following function:

    GETFLDSTATE(-1)

    For example, this value can be a character string consisting of deletion and edit status values for all fields in the table or cursor. If a table has five fields and only the first field has been edited, GETFLDSTATE( ) returns a value of 121111. The number 1 in the first position indicates the deletion status has not been changed.

  • lForce
    Specifies the value of the lForce parameter from the TABLEUPDATE( ) function.

  • cDeleteCmd
    Specifies the value of the DeleteCmd property. Visual FoxPro uses the value of cDeleteCmd as the delete command, which you can change in this event. However, if you change the value of the cDeleteCmd parameter, the value of the DeleteCmd property does not change.

Remarks

If code in BeforeDelete returns False (.F.), the delete operation does not occur.

See Also

Events | CursorAdapter Object Properties, Methods, and Events | GETFLDSTATE( ) Function | TABLEUPDATE( ) Function | DeleteCmd Property | AfterDelete Event

Applies To: CursorAdapter Class