UserDataMap.ItemValue operator

Introduced

v3.0

Description

Returns or sets the data on a particular component inside the user data map as a String.

The user data is represented as a string for the sake of scripting languages, but from C++ it is also possible to encode binary data.

This is equivalent to retrieving a UserDataItem with UserDataMap.Item and then using the UserDataItem.Value property.

Note: Since Python does not support input parameters on properties, this will fail in Python. Use the Python-compliant UserDataMap.GetItemValue2 method instead.

Warning: If your plug-in accesses UserDataMap data on multiple platforms (Windows vs. Linux), the contents of the ItemValue property might not translate exactly because the size of a character differs from one OS to the other.

C# Syntax

// get accessor
String UserDataMap.get_ItemValue( Int32 in_ulIndex );
// set accessor
UserDataMap.set_ItemValue( Int32 in_ulIndex, String out_pbstrVal );

Parameters

Parameter Type Description
Index Long Index of the component within the cluster.

See Also

UserDataMap.GetItemValue2 UserDataItem.Value