Sandcastle Help File Builder Documentation
Target
This attempts to retrieve the item with the specified key, returning it along with the reference
link type with which it is associated.
Definition
Namespace: Sandcastle.Tools.BuildComponents.Targets
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.12.21.0
True if the item was found, false if not
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.12.21.0
C#
public bool TryGetValue(
string key,
out Target value,
out ReferenceLinkType linkType
)VB
Public Function TryGetValue (
key As String,
<OutAttribute> ByRef value As Target,
<OutAttribute> ByRef linkType As ReferenceLinkType
) As BooleanC++
public:
bool TryGetValue(
String^ key,
[OutAttribute] Target^% value,
[OutAttribute] ReferenceLinkType% linkType
)F#
member TryGetValue :
key : string *
value : Target byref *
linkType : ReferenceLinkType byref -> bool Parameters
- key String
- The item key to look up
- value Target
- On return, this will contain the item value if found
- linkType ReferenceLinkType
- On return, this will contain the link type of the item if found
Return Value
BooleanTrue if the item was found, false if not