MetadataBuilder.ReserveUserString(Int32) Method

Definition

Namespace:

System.Reflection.Metadata.Ecma335

Assembly:

System.Reflection.Metadata.dll

Package:

System.Reflection.Metadata v9.0.0-preview.3.24172.9

Source:

MetadataBuilder.Heaps.cs

Reserves space on the user string heap for a string of the specified length.

public:
 System::Reflection::Metadata::ReservedBlob<System::Reflection::Metadata::UserStringHandle> ReserveUserString(int length);

public System.Reflection.Metadata.ReservedBlob<System.Reflection.Metadata.UserStringHandle> ReserveUserString (int length);

member this.ReserveUserString : int -> System.Reflection.Metadata.ReservedBlob<System.Reflection.Metadata.UserStringHandle>

Public Function ReserveUserString (length As Integer) As ReservedBlob(Of UserStringHandle)

Parameters

length

Int32

The number of characters to reserve.

Returns

ReservedBlob<UserStringHandle>

A handle to the reserved user string and a Blob representing the entire User String blob (including its length and terminal character). The handle may be used in LoadString(UserStringHandle). Use WriteUserString(String) to fill in the blob content.

Exceptions

ImageFormatLimitationException

The remaining space on the heap is too small to fit the string.

ArgumentOutOfRangeException

length is negative.