Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

GetItemFieldOptions

Synopsis

struct GetItemFieldOptions : ItemSelectionOptions {
    boolean *useDefault;
    boolean *expandVariables;
    boolean *resolveURI;
    boolean *useImageCache;
    boolean *generateImages;
}

See also: ItemSelectionOptions

The options parameter may specify the following options to control field access and representation of the return value:

useDefault

if true, and a field has no value, than the default value of the field (if any) will be used instead

expandVariables

if true, variables found in the field (or the field’s default value) are expanded

resolveURI

if true, and the field is of a predefined column with attribute ID CatalogImage, ArticleImage or GeneratedImage, or a user defined column with type Image, an attempt is made to interpret the field’s value as an absolute URI and, if the URIs scheme is file, gen or imp, to produce an HTTP URL for this URI. If a HTTP URL could be produced, then the HTTP URL will be returned as the field’s value. Otherwise, the original value of the field will be returned.

useImageCache

If specified and true, try to fetch the generated image from the global cache if the operation getItemFields has been called to return a generated image or article image and the current position does not already reference a generated image.

Default value: false

generateImages

If specified and true, try to fetch the generated image from the global cache if the operation getItemFields has been called to return a generated image or article image and the current position does not already reference a generated image. Generate the image if it has not been found in the cache.

Default value: false

Note: It is not possible to bypass the cache with useImageCache set to false and generateImages set to true. The latter one set to true always causes a cache lookup before the image is eventually generated.