VirtualPathProvider.GetCacheDependency Method (String, IEnumerable, DateTime)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Creates a cache dependency based on the specified virtual paths.

Namespace:   System.Web.Hosting
Assembly:  System.Web (in System.Web.dll)

public virtual CacheDependency GetCacheDependency(
	string virtualPath,
	IEnumerable virtualPathDependencies,
	DateTime utcStart


Type: System.String

The path to the primary virtual resource.

Type: System.Collections.IEnumerable

An array of paths to other resources required by the primary virtual resource.

Type: System.DateTime

The UTC time at which the virtual resources were read.

Return Value

Type: System.Web.Caching.CacheDependency

A CacheDependency object for the specified virtual resources.

The default implementation of the GetCacheDependency method returns null. To cache virtual resources for later use you must override either the GetCacheDependency method or the GetFileHash method.

The following code example implements the GetCacheDependency method for a custom VirtualPathProvider class. For the full code required to run the example, see the Example section of the VirtualPathProvider class overview topic.

public override CacheDependency GetCacheDependency(
  string virtualPath, 
  System.Collections.IEnumerable virtualPathDependencies, 
  DateTime utcStart)
  if (IsPathVirtual(virtualPath))
    System.Collections.Specialized.StringCollection fullPathDependencies = null;

    // Get the full path to all dependencies.
    foreach (string virtualDependency in virtualPathDependencies)
      if (fullPathDependencies == null)
        fullPathDependencies = new System.Collections.Specialized.StringCollection();

    if (fullPathDependencies == null)
      return null;

    // Copy the list of full-path dependencies into an array.
    string[] fullPathDependenciesArray = new string[fullPathDependencies.Count];
    fullPathDependencies.CopyTo(fullPathDependenciesArray, 0);
    // Copy the virtual path into an array.
    string[] virtualPathArray = new string[1];
    virtualPathArray[0] = virtualPath;

    return new CacheDependency(virtualPathArray, fullPathDependenciesArray, utcStart);
    return Previous.GetCacheDependency(virtualPath, virtualPathDependencies, utcStart);

.NET Framework
Available since 2.0
Return to top