Export (0) Print
Expand All

RoleEnvironment.GetLocalResource Method

Updated: December 6, 2013

Retrieves a specified local storage resource.

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

[SecurityPermissionAttribute(SecurityAction.Assert, UnmanagedCode=true)] 
public static LocalResource GetLocalResource (
	string localResourceName
)

Parameters

localResourceName

Type: System.String

The name of the local storage resource that is defined in the ServiceDefiniton.csdef file.

Return Value

Type: Microsoft.WindowsAzure.ServiceRuntime.LocalResource

An instance of LocalResource that represents the local storage resource.

Exception typeCondition
RoleEnvironmentException

The local storage resource does not exist.

The following code example shows how to use this method to retrieve the local storage resource and write a text file to the resource:

try
{
    // Retrieve an object that points to the local storage resource.
    LocalResource localResource = RoleEnvironment.GetLocalResource("localStoreTwo");

    // Define the file name and path.
    string[] paths = { localResource.RootPath, "MyStorageTest.txt" };
    String filePath = Path.Combine(paths);

    using (FileStream writeStream = File.Create(filePath))
    {
        Byte[] textToWrite = new UTF8Encoding(true).GetBytes("Testing Web role storage");
        writeStream.Write(textToWrite, 0, textToWrite.Length);
    }
}
catch (RoleEnvironmentException e)
{
    Console.WriteLine("The local resource isn't defined or doesn't exist. \n" + e.ToString());
}


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

Development Platforms

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

Target Platforms

Community Additions

ADD
Show:
© 2014 Microsoft