1 out of 2 rated this helpful - Rate this topic

RoleEnvironment.GetLocalResource Method

Retrieves a specified local storage resource.

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

Usage

Copy

'Usage
Dim localResourceName As String
Dim returnValue As LocalResource

returnValue = RoleEnvironment.GetLocalResource(localResourceName)

Syntax

C++

Copy

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

Copy

/** @attribute SecurityPermissionAttribute(SecurityAction.Assert, UnmanagedCode=true) */ 
public static LocalResource GetLocalResource (
	String localResourceName
)

JScript

Copy

public static function GetLocalResource (
	localResourceName : String
) : LocalResource

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.

Exceptions

Exception type	Condition
RoleEnvironmentException	The local storage resource does not exist.

Remarks

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

Copy

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());
}

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 and Windows Server 2008

Target Platforms

Change History

Reference

RoleEnvironment Class
RoleEnvironment Members
Microsoft.WindowsAzure.ServiceRuntime Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ