Store
Stores a document property.
Read time 2 minutesLast updated 10 days ago
Definition
- Type: Method
- Namespace: UnityEditor.Search
- Assembly: UnityEditor
Store(string, string, Object)
Stores a document property.
public bool Store(string documentId, string propertyPath, object value)
Parameters
Returns
Type | Description |
|---|---|
| bool | True if the store operation succeeded, false if not. |
Examples
// Store a property of a document, like a property of an asset.var stored = propertyDatabase.Store("path/to/my/asset", "m_Color", new Color(1, 0, 1));if (!stored) Debug.LogWarning("Property m_Color did not store.");
Store(ulong, Hash128, Object)
Stores a document property with a precomputed document key and property hash.
public bool Store(ulong documentKey, Hash128 propertyHash, object value)
Parameters
Returns
Type | Description |
|---|---|
| bool | True if the store operation succeeded, false if not. |
Remarks
// Store a property of a document, with the document id and property hash already computed.var documentId = PropertyDatabase.CreateDocumentKey("path/to/my/asset");var propertyHash = PropertyDatabase.CreatePropertyHash("m_Size");stored = propertyDatabase.Store(documentId, propertyHash, 42);if (!stored) Debug.LogWarning("Property m_Size did not store.");
Additional Resources: PropertyDatabase.CreateDocumentKey and PropertyDatabase.CreatePropertyHash.
Store(Hash128, Object)
Stores a property with a precomputed property hash.
public bool Store(Hash128 propertyHash, object value)
Parameters
Returns
Type | Description |
|---|---|
| bool | True if the store operation succeeded, false if not. |
Remarks
The document identifier is considered null and the document key will be 0.
// Store a property without any document.stored = propertyDatabase.Store(PropertyDatabase.CreatePropertyHash("documentPrefix"), "myDocs_");if (!stored) Debug.LogWarning("Property documentPrefix did not store.");
Additional Resources: PropertyDatabase.CreatePropertyHash.
Store(PropertyDatabaseRecordKey, Object)
Stores a document property with a precomputed record key.
public bool Store(in PropertyDatabaseRecordKey recordKey, object value)
Parameters
Returns
Type | Description |
|---|---|
| bool | True if the store operation succeeded, false if not. |
Remarks
// Store a property with an already computed record key.var recordKey = PropertyDatabase.CreateRecordKey("path/to/my/asset", "prop1");stored = propertyDatabase.Store(recordKey, 123);if (!stored) Debug.LogWarning("Property prop1 did not store.");
Additional Resources: PropertyDatabase.CreateRecordKey.