Dict_LockCustom()

Examples


The Dict_LockCustom() function attempts to open a forms or reports dictionary. If it can, it locks the dictionary, preventing other users from accessing the dictionary.

Syntax

Dict_LockCustom(product_ID, form_flag, report_flag)

Parameters

product_ID – An integer specifying the application’s product ID.

form_flag – A returned integer indicating whether the forms dictionary is available:

[spacer]

Value

Description

0

No error

1

No dictionary

2

Unable to open


If the result is no error (0), the forms dictionary is opened and locked.

report_flag – A returned integer indicating whether the reports dictionary is available:

[spacer]

Value

Description

0

No error

1

No dictionary

2

Unable to open


If the result is no error (0), the reports dictionary is opened and locked.

Return value

A boolean representing the result; true only if both the forms and reports dictionaries are available, and false if one or both are unavailable.

Comments

Always use the Dict_UnlockCustom() function to release a lock on a custom dictionary.

This function will work only if your application is opened with the runtime engine. Dexterity test mode has no provisions for accessing information for forms and reports dictionaries.



Documentation Feedback