Share via

SqlMetadataStore.OpenStore Method (String)

  • Article

Opens an existing metadata store file that has the specified name and location, and returns a metadata store object that represents it.

Namespace:  Microsoft.Synchronization.MetadataStorage
Assembly:  Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)

Syntax

'Declaration
Public Shared Function OpenStore ( _
    fileName As String _
) As SqlMetadataStore
'Usage
Dim fileName As String
Dim returnValue As SqlMetadataStore

returnValue = SqlMetadataStore.OpenStore(fileName)

public static SqlMetadataStore OpenStore(
    string fileName
)

public:
static SqlMetadataStore^ OpenStore(
    String^ fileName
)

static member OpenStore : 
        fileName:string -> SqlMetadataStore 

public static function OpenStore(
    fileName : String
) : SqlMetadataStore

Parameters

  • fileName
    Type: System.String
    The file path and file name for the database file. The file path can be a relative path. In this case, it is relative to the current directory.

Return Value

Type: Microsoft.Synchronization.MetadataStorage.SqlMetadataStore
The metadata store object that represents the database.

Exceptions

Exception Condition
ArgumentNullException

fileName is a null reference (Nothing in Visual Basic).
ArgumentException

fileName is 0 length.
PathTooLongException

fileName is longer than 260 characters.
FileNotFoundException

The file that is specified in fileName does not exist.
MetadataStorageEngineException

fileName is only a directory and does not contain a file name, or the metadata store could not be opened.

Remarks

This method opens an existing metadata store. To create a new metadata store, use CreateStore().

This method uses CurrentCulture as the locale for the database file.

Security noteSecurity Note

The metadata file is not secured against unauthorized access. To help protect the metadata file, the folder that contains it must be properly secured, such as by using a Discretionary Access Control List (DACL). To allow the user to delete the metadata file, the provider that creates the metadata file should put it somewhere the user can access. The provider that creates the metadata file must delete the metadata file when the provider is uninstalled.
Security noteSecurity Note

When Sync Framework opens the metadata file by a remote mechanism, such as a UNC path, the metadata file cannot be simultaneously accessed by any other application on any computer, including an application on the machine where the metadata file is stored.

See Also

Reference

SqlMetadataStore Class

OpenStore Overload

Microsoft.Synchronization.MetadataStorage Namespace