Export (0) Print
Expand All
Expand Minimize

SPSite.Protocol property

Gets the protocol that is used by the server.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

public string Protocol { get; }

Property value

Type: System.String
A string that specifies the protocol and ends with a colon (":"). The value is either "http:" or "https:", depending on the URL that is used in constructing the SPSite object.

The following example is a console application that constructs an absolute URL for the default page of a child Web site in a site collection. The example assumes that http://localhost/sites/sitecollection is a valid URL for a site collection and that the collection has a child Web site named "subsite".

Note that the example's method for creating a URL is intentionally indirect. The code that builds an absolute URL for the site collection could be replaced by a single line that accesses the Url property, which returns an absolute URL. However, the example takes a longer path in order to demonstrate how properties of the SPSite object give easy access to parts of the URL.

using System;
using Microsoft.SharePoint;

namespace Test
{
   class ConsoleApp
   {
      static void Main(string[] args)
      {
         using (SPSite site = new SPSite("http://localhost/sites/sitecollection"))
         {
            using (SPWeb web = site.OpenWeb("subsite"))
            {
               string absoluteUrl = site.Protocol + "//";
               absoluteUrl += site.HostName + ":" + site.Port.ToString();
               absoluteUrl += web.RootFolder.ServerRelativeUrl;
               absoluteUrl += "default.aspx";
               Console.WriteLine(absoluteUrl);
            }
         }
         Console.ReadLine();
      }
   }
}
Show:
© 2014 Microsoft