ItemProperty

Returns the value of a named property of a Qubes item.

Syntax

ItemProperty(itemGPAOID, propName)
itemGPAOID = a Qubes item's GPAOID
propName = name of the item property whose value you want to retrieve

Remarks

(Qubes 9.0) Returns "" if the requested GPAOID is an empty string.

Returns #VAL! if the requested item or property does not exist.
With Rendering Version 20231024 (Qubes 10.0) this behavior is changed to return and empty string when itemGPAOID is an empty string.

Alias functions provide direct access to certain properties.
The following properties can be accessed:

NameRetrieved informationDirect alias
GPAOIDItem GPAOIDItemGPAOID(itemGPAOID)
NAMEItem nameItemName(itemGPAOID)
DESCRIPTIONDescription of the itemItemDescription(itemGPAOID)
UNITItem management unit (abbreviation)ItemUnit(itemGPAOID)
BATCHIs the item managed by batch?ItemBatch(itemGPAOID)
TRACE_LOCALIs the item's quantity traced locally?ItemTraceLocal(itemGPAOID)
TRACE_GLOBALIs the item's quantity traced globally?ItemTraceGlobal(itemGPAOID)
PEREMPTIONIs an expiration date managed for this item?ItemPeremption(itemGPAOID)
FAMILYItem familyItemFamily(itemGPAOID)
SUB_FAMILYItem sub-familyItemSubFamily(itemGPAOID)
PARAMS.xxxValue of parameter "xxx"ItemParameter(itemGPAOID, paramName[, defaultValue])

Example

If you have an item with a GPAOID of "A012" and a name of "ART005" that is managed by batch, you will get:

ItemProperty("A012", "NAME") = "ART005"
ItemName("A012") = "ART005"
ItemBatch("A012") = true

Classification

Qubes