Dict_GetCustomResourceInfo()

Examples


The Dict_GetCustomResourceInfo() function returns information about a form in a forms dictionary, or a report in a reports dictionary.

Syntax

Dict_GetCustomResourceInfo(product_ID, resource_type, index, series, resource_name)

Parameters

product_ID – The product ID of the dictionary whose forms or reports dictionaries contain forms or reports you’re retrieving information about.

resource_type – An integer specifying the type of resource for which you want information returned. Use one of the following constants:

[spacer]

Constant

Description

REPORTTYPE

Indicates a report resource type.

FORMTYPE

Indicates a form resource type.


index – An integer specifying a resource in the forms or reports dictionary. An index of 1 specifies the first form or report in the selected series, 2 specifies the second, and so on.

series – An integer specifying the series from which you want to retrieve form or report information. The following table lists all series that can be applied to forms and reports and their corresponding integer values.

[spacer]

1–Financial

2–Sales

3–Purchasing

4–Inventory

5–Payroll

6–Project

7–System

8–Company

9–Online Documentation

10–3rd Party

11–Macro System

12–Palette

13–Dexterity

14–Dexterity System

15–Report Writer


resource_name – A returned string containing the name of the form or report. For forms, this is the display name of the first window in the form.

Return value

An integer containing the resource ID for the form or report for which information was retrieved.

Comments

Use the count returned by Dict_CountCustomResource() in a for do...end for loop to fill a list with the values for the resource_name.

Counting forms or reports in a custom dictionary 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.


Check the availability of the custom dictionary using the Dict_LockCustom() function prior to using this function. Use the Dict_UnlockCustom() function to release the lock on a custom dictionary.


Documentation Feedback