lib_get_vault_component
Verify whether a managed Workspace component can be placed without placing it by probing its Design Item ID and reporting library path, lifecycle state, revisions, and placement parameters.
Instructions
Check one managed (Workspace) component can be placed, without placing it.
Loads the item the way sch_place_vault_components would, reads
its identity, and throws it away again; nothing reaches a sheet.
The kind asked for is tried first, then the others. The library
manager's lookups (library path, lifecycle state, revisions,
placement parameters) are reported alongside, as they come back.
A part number is not looked up here, so bring the Design Item ID.
Args:
design_item_id: The component's Design Item ID.
vault: The Workspace name. Usually left out; see
lib_get_vault_name.
lib_identifier_kind: Altium's TLibIdentifierKind, tried first:
0 Any, 1 NameNoType, 2 NameWithType, 3 FullPath, 4 VaultName
(the default). A managed part Altium placed shows the kind
and identifier that work, through obj_query on
eSchComponent.
Returns:
placeable, loader_callable, lib_identifier_kind (the
kind that loaded, -1 if none), load_probe (kind:result
for each try), the loaded loaded_design_item_id,
vault_guid, item_guid and revision_guid, then
library_path, display_path, lifecycle_state,
has_revisions, revisions, placement_parameters,
note and diag (library manager calls that raised).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vault | No | ||
| design_item_id | Yes | ||
| lib_identifier_kind | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||