Questo è un metodo comune. Eventuali limitazioni di implementazione specifiche della piattaforma saranno elencate negli argomenti relativi agli oggetti che utilizzano questo metodo.
Questa proprietà consente di associare a un oggetto qualsiasi informazione definita dall’utente. Queste informazioni vengono passate come VARIANT, che può contenere solo tipi semplici (String, tipi interi), ma non può contenere al suo interno tipi SAFEARRAY o VARIANT. Più precisamente, sono consentiti solo i seguenti tipi di variant: VT_EMPTY, VT_UI1, VT_I2, VT_I4, VT_R4, VT_R8, VT_CY, VT_BSTR, VT_NULL, VT_ERROR, VT_BOOL, VT_DATE.
HRESULT get_UserProperty(
BSTR name,
VARIANT* result
);
HRESULT put_UserProperty(
BSTR name,
VARIANT value
);
object get_UserProperty( string name );
void set_UserProperty(
string name,
object value
);
Property UserProperty(name As String) As Object
name
[in] Questa variabile contiene un valore string qualsiasi da usare per identificare la proprietà tra le altre, ad esempio “MyProperty”.
result
[out, retval] Un puntatore a una variabile VARIANT che riceve il valore della proprietà definita dall’utente.
value
[in] Una variabile VARIANT che contiene il nuovo valore della proprietà.
Questa proprietà non restituisce valori di ritorno specifici. Restituisce i valori di ritorno standard delle funzioni di ABBYY FineReader Engine.
Le proprietà sono identificate dai rispettivi nomi. Pertanto, per un determinato oggetto è consentita una sola proprietà con il nome specificato. Se un oggetto non dispone di una proprietà utente con il nome specificato, questa viene creata alla prima assegnazione di un valore. Se si tenta di ottenere il valore di una proprietà che non esiste in un oggetto, viene restituito un VARIANT vuoto. Quando si copia un oggetto tramite il metodo CopyFrom, vengono copiate anche le proprietà definite dall’utente. Se un oggetto può essere persistente, anche le proprietà definite dall’utente risultano persistenti.
Questa proprietà è disponibile per i seguenti oggetti:
Lavorare con le proprietà