CloudQueue.EncodeMessage Property

Storage Client Library NET API

previous page next page

[This topic is part of the Microsoft Azure Storage Client Library 1.7, which has been deprecated. See Storage Client Library for the latest version.]

Gets or sets a value indicating whether to apply Base64 encoding when adding or retrieving messages.

Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)

Usage

Visual Basic
Dim instance As CloudQueue Dim value As Boolean value = instance.EncodeMessage instance.EncodeMessage = value

Syntax

Visual Basic
Public Property EncodeMessage As Boolean

C#
public bool EncodeMessage { get; set; }

C++
public: property bool EncodeMessage { bool get (); void set (bool value); }

J#

JScript

Property Value

Type: System.Boolean

True to encode messages; otherwise, false. The default value is true.

Remarks

The storage client library encodes the message content using Base64 when EncodeMessage is set to true. You can set this property to false if the content of your messages is safe to pass in XML as raw UTF-8 with no Base64 encoding.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012