Version: 2022.3
LanguageEnglish
  • C#

PropertyContainer.TryGetValue

Leave feedback
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 bool TryGetValue(TContainer container, string name, out TValue value);

Parameters

container The container whose property value will be returned.
name The name of the property to get.
value When this method returns, contains the value associated with the specified name, if the property is found. otherwise the default value for the <typeparamref name="TValue" />.

Returns

bool <see langword="true" /> if the value exists for the specified name; otherwise, <see langword="false" />.

Description

Gets the value of a property by name.

Declaration

public static bool TryGetValue(TContainer container, ref Unity.Properties.PropertyPath path, out TValue value);

Parameters

container The container whose property value will be returned.
path The path of the property to get.
value When this method returns, contains the value associated with the specified path, if the property is found. otherwise the default value for the <typeparamref name="TValue" />.

Returns

bool <see langword="true" /> if the value exists at the specified path; otherwise, <see langword="false" />.

Description

Gets the value of a property by path.

Declaration

public static bool TryGetValue(ref TContainer container, ref Unity.Properties.PropertyPath path, out TValue value, out Unity.Properties.VisitReturnCode returnCode);

Parameters

container The container whose property value will be returned.
path The path of the property to get.
value When this method returns, contains the value associated with the specified path, if the property is found. otherwise the default value for the <typeparamref name="TValue" />.
returnCode When this method returns, contains the return code.

Returns

bool <see langword="true" /> if the value exists at the specified path; otherwise, <see langword="false" />.

Description

Gets the value of a property by path.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2024 Unity Technologies. Publication Date: 2024-12-18.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information