Share via


SqlUserDefinedAggregateAttribute.MaxByteSize Property

Definition

The maximum size, in bytes, of the aggregate instance.

public:
 property int MaxByteSize { int get(); void set(int value); };
public int MaxByteSize { get; set; }
member this.MaxByteSize : int with get, set
Public Property MaxByteSize As Integer

Property Value

An Int32 value representing the maximum size of the aggregate instance.

Remarks

This property does not have to be specified for Native format serialization.

You must specify the MaxByteSize property with the UserDefined serialization Format.

The maximum allowed value for this property is specified by the MaxByteSizeValue field.

The maximum size allowed is 2 gigabytes (GB). You can specify a number from 1 to 8000 bytes, or -1 to represent a value larger than 8000 bytes, up to 2 gigabytes.

For an aggregate with user-defined serialization specified, MaxByteSize refers to the total size of the serialized data. Consider an aggregate serializing a string of 10 characters (Char). When the string is serialized using a BinaryWriter, the total size of the serialized string is 22 bytes: 2 bytes per Unicode UTF-16 character, multiplied by the maximum number of characters, plus 2 control bytes of overhead incurred from serializing a binary stream. So, when determining the value of MaxByteSize, the total size of the serialized data must be considered: the size of the data serialized in binary form plus the overhead incurred by serialization.

Applies to