Version: 2021.3
LanguageEnglish
  • C#

AtomicSafetyHandle.NewStaticSafetyId

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static int NewStaticSafetyId(byte* ownerTypeNameBytes, int byteCount);

Parameters

ownerTypeNameBytes The name of the scripting type that owns this AtomicSafetyHandle, to be embedded in error messages involving the handle. This is expected to be a UTF8-encoded byte array, and is not required to be null-terminated.
byteCount The number of bytes in the ownerTypeNameBytes array, excluding the optional null terminator.

Returns

int The newly allocated safety ID.

Description

Allocates a new static safety ID, to store information for the provided type T.

After creating a new static safety id, assign it to the applicable AtomicSafetyHandle instances using SetStaticSafetyId.

The job debugger uses this static safety ID to look up the provided type's name, as well as custom error messages created with SetCustomErrorMessage. Without this information, the job debugger can only emit general error messages that may not clearly identify the source of the error.


Declaration

public static int NewStaticSafetyId();

Returns

int The newly allocated safety ID.

Description

Allocates a new static safety ID, to store information for the provided type T.

After creating a new static safety id, assign it to the applicable AtomicSafetyHandle instances using SetStaticSafetyId.

The job debugger uses this static safety ID to look up the provided type's name, as well as custom error messages created with SetCustomErrorMessage. Without this information, the job debugger can only emit general error messages that may not clearly identify the source of the error.

This variant uses the name of the provided type T as the handle's owner type name.