MagicWordCollectionTryGetByAlias Method

This is preliminary documentation and is subject to change.

Tries to lookup a magic word by alias (wikitext) in the collection.

Namespace: WikiClientLibrary.Sites
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.4+fbadc980737ddc9bb67116900ecad57f84a0b241

Syntax

C++

Copy

public MagicWordInfo? TryGetByAlias(
	string alias
)

Public Function TryGetByAlias ( 
	alias As String
) As MagicWordInfo

Dim instance As MagicWordCollection
Dim alias As String

Dim returnValue As MagicWordInfo

returnValue = instance.TryGetByAlias(alias)

public:
MagicWordInfo^ TryGetByAlias(
	String^ alias
)

member TryGetByAlias : 
        alias : string -> MagicWordInfo

Parameters

alias String: the magic word alias.

Return Value

MagicWordInfo
a magic word entry, or null if a matching magic word cannot be found.

Exceptions

Exception	Condition
ArgumentNullException	alias is null.

Remarks

This function checks CaseSensitive for case-sensitivity during lookup.

To look for a magic word by its magic word ID, use TryGet(String) or ItemString.

Reference

MagicWordCollection Class

WikiClientLibrary.Sites Namespace