IFlagNameProvider Interface
Attempts to find a friendly name assigned to a Flag of a specific value.
public interface IFlagNameProviderMethods
Section titled “Methods”IFlagNameProvider.GetName(Flag) Method
Section titled “IFlagNameProvider.GetName(Flag) Method”Gets the friendly name of the given flag. If none is found, System.String.Empty will be returned. Should never return null.
string GetName(HAKOM.TSM.Net.Api.Flags.Flag flag);Parameters
Section titled “Parameters”flag Flag
The Flag for which to get the name.
Returns
Section titled “Returns”System.String
The friendly name assigned to the flag or System.String.Empty.
IFlagNameProvider.TryGetName(Flag, string) Method
Section titled “IFlagNameProvider.TryGetName(Flag, string) Method”Attempts to get the friendly name for the given flag from this IFlagNameMapping.
bool TryGetName(HAKOM.TSM.Net.Api.Flags.Flag flag, out string name);Parameters
Section titled “Parameters”flag Flag
The Flag for which to get the name.
name System.String
If successful, contains the name that represents the given flag. Null otherwise.
Returns
Section titled “Returns”System.Boolean
True if this IFlagNameMapping contains a name for the given flag.
Was this page helpful?Thanks for your feedback!