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

ImageInfo

Synopsis

struct ImageInfo
{
    string tag;
    string url;
    string[] attributes;
    string? itemId;
    boolean? generated; // attribute
}

Instances of ImageInfo describe images associated with basket items. They are returned by getImages and passed to setImages. The generated attribute distinguishes generated image resources from ordinary imported images. For setImages, itemId is mandatory even though it is optional in the XSD.

tag

The tag used to identify an item image, as specified by getGeneratedImage or setImages. An empty tag identifies the configuration-specific article image (also called the PBK image; see getImages).

url

With the default getImages option resolveURIs=true, this field contains an HTTP(S) URL that can be used to download the image and is valid until the session is closed. With resolveURIs=false, it contains a gen or imp URI. For setImages, specify an HTTP(S) URL known to the server and accessible to the session, or a gen or imp URI referencing an image already imported into the project.

The generated attribute is optional. For setImages, gen URIs require generated=true (and default to true); imp URIs require generated=false (and default to false). For HTTP(S) URLs, generated defaults to true if tag is empty, and false otherwise. An empty tag identifies a configuration-specific article image and requires an OFML article item and generated=true.

The attributes field contains key=value pairs. Keys must be valid ANSI C identifiers. Duplicate attributes are discarded, with the last value prevailing. For setImages, attributes must not be specified with gen or imp URIs; the stored resource attributes are used instead. See setImages and Imported File Attributes for import rules and supported attributes.