UserDataBlob.Value operator

Introduced

v3.5

Description

Sets or returns binary user data on the UserDataBlob as a BSTR (String).

The data is copied internally and will be persisted as part of the scene. There are no limits to the size or structure of this data.

From scripting it is certainly possible to store strings on a UserDataBlob using this property. This is similar to saving a string in a parameter on a CustomProperty object.

Warning: If your plug-in accesses UserDataBlob data on multiple platforms (Windows vs. Linux), it is safer to use the UserDataBlob.ByteArray or the UserDataBlob.Array32 property instead. The contents of the Value property do not translate exactly the same because the size of a character differs from one OS to the other. The UserDataBlob.Array32 property is an optimization of the UserDataBlob.ByteArray property and the preferred language for working with these two properties is Python.

C# Syntax

// get accessor
String rtn = UserDataBlob.Value;
// set accessor
UserDataBlob.Value = String;

See Also

UserDataBlob.ByteArray UserDataBlob.Array32 UserDataItem.Value CustomProperty.BinaryData CustomProperty.AddParameter