Retrieves a specified local storage resource.
Namespace: Microsoft.WindowsAzure.ServiceRuntime
Assembly: Microsoft.WindowsAzure.ServiceRuntime (in Microsoft.WindowsAzure.ServiceRuntime.dll)
Usage
Dim localResourceName As String
Dim returnValue As LocalResource
returnValue = RoleEnvironment.GetLocalResource(localResourceName)
Syntax
<SecurityPermissionAttribute(SecurityAction.Assert, UnmanagedCode:=True)> _
Public Shared Function GetLocalResource ( _
localResourceName As String _
) As LocalResource
[SecurityPermissionAttribute(SecurityAction.Assert, UnmanagedCode=true)]
public static LocalResource GetLocalResource (
string localResourceName
)
[SecurityPermissionAttribute(SecurityAction::Assert, UnmanagedCode=true)]
public:
static LocalResource^ GetLocalResource (
String^ localResourceName
)
/** @attribute SecurityPermissionAttribute(SecurityAction.Assert, UnmanagedCode=true) */
public static LocalResource GetLocalResource (
String localResourceName
)
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.LocalResourceAn instance of
LocalResource that represents the local storage resource.
Exceptions
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:
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
See Also