Click or drag to resize

AzureTableSettingsGetBytes(Object, Object, Byte) Method

Gets a byte array value of a setting, or a default fallback value if the setting is not found.

Namespace: Orthogonal.NSettings.AzureTable
Assembly: Orthogonal.NSettings.AzureTable (in Orthogonal.NSettings.AzureTable.dll) Version: 3.0.5
Syntax
C#
public Task<byte[]> GetBytes(
	Object? appKey,
	Object itemKey,
	byte[] fallback
)

Parameters

appKey  Object
  • An object that optionally provides the application primary key part of the two-part key for a setting. The object value is internally converted to a key string by calling its ToString method. A null value is allowed which is suitable for settings which are not associated with any specific application or perhaps shared between applications.
  • An application primary key can be used to partition settings into groups so they can be more easily managed, such as listing or deleting them all at the application key level.
  • The application key is case sensitive.
  • Hint: It is good coding practise to specify the application key as an enumerated value or a global string constant.
itemKey  Object
  • An object that provides the item secondary key part of the two-part key for a setting. The object value is internally converted to a key string by calling its ToString method.
  • The item key is case sensitive.
  • Hint: It is good coding practise to specify the item key using the C# or Visual Basic nameof operator.
fallback  Byte
A default value (aka fallback value) to return if no setting is found with the specified appKey and itemKey.

Return Value

TaskByte
A Task representing the asynchronous operation. The completed Task's Result property contains the setting's value if it exists. If the setting is not found then the fallback value is returned.
See Also