Successful Return Values

  • Article

Applies to: SharePoint Foundation 2010

A successful return value for FrontPage Server Extensions from Microsoft contains either or both of the following:

  • A message that the method completed successfully.

  • The name of the method and a bulleted list of meta-keys and values for the page, set of pages, or Web site upon which the method acted.

Form of Return Value

The return value is always in the form of an HTML formatted page, such as the following example:

<html><head><title>vermeer.RPC.packet</title></head>LF
<body>LF<p>method=get document:6.0.n.nnnnLF <p>message=successfully 
retrieved document'
_borders/left.htm'from'D:&#92;Inetpub&#92;wwwroot&#92;allnew&#92;
_borders&#92;left.htm'LF<p>document=LF<ul>LF<li>document_name=
_borders/left.htmLF<li>meta_info=LF<ul>LF<li>vti_authorLF
<li>SR|authorLF<li>vti_modifiedbyLF<li>SR|authorLF<li>vti_timecreatedLF
<li>TR|05 Nov 1998 22:23:06 -0000LF<li>vti_timelastmodifiedLF
<li>TR|09 Nov 1998 17:03:06-0000LF<li>vti_backlinkinfoLF<li>VX|LF
<li>vti_filesizeLF<li>IR|574LF<li>vti_titleLF<li>SW|Left.BorderLF
<li>vti_categoriesLF<li>VW|LF<li>vti_metatagsLF
<li>VR|GENERATOR.Microsoft&#92;.FrontPage&#92;.6.0.ProgId.FrontPage.
Editor.Document.LF<li>vti_progidLF<li>SR|FrontPage Editor DocumentLF
<li>vti_generatorLF<li>SR|Microsoft FrontPage 6.0LF
<li>vti_nexttolasttimemodifiedLF<li>TR|05 Nov 2003 22:23:21 -0000 
LF<li>vti_themeaggregateLF<li>SR|defaultLF<li>vti_navbitsLF
<li>SW|CLF<li>vti_timelastwrittenLF<li>TX|09 Nov 2003 17:03:06 
-0000LF</ul>LF</ul>LF</body>LF</html>

If this example is viewed in a browser, it takes this form:

method=get.document:6.0.n.nnnn.

message=successfully.retrieved.document.'_borders/left.htm'.from.
'D:\Inetpub\wwwroot\allnew\_borders\left.htm'.
document=.

document_name=_borders/left.htm

meta_info=

  • vti_author.

  • SR|robf.

  • vti_modifiedby.

  • SR|robf.

  • vti_timecreated.

  • TR|05.Nov.2003.22:23:06.-0000.

  • vti_timelastmodified.

  • TR|09.Nov.2003.17:03:06.-0000.

  • vti_backlinkinfo.

  • VX|.

  • vti_filesize.

  • IR|574.

  • vti_title.

  • SW|Left.Border.

  • vti_categories.

  • VW|.

  • vti_metatags.

  • VR|GENERATOR.Microsoft\.FrontPage\.6.0.ProgId.FrontPage.Editor.Document.

  • vti_progid.

  • SR|FrontPage.Editor.Document.

  • vti_generator.

  • SR|Microsoft.FrontPage.6.0.

  • vti_nexttolasttimemodified.

  • TR|05.Nov.2003.22:23:21.-0000.

  • vti_themeaggregate.

  • SR|default.

  • vti_navbits.

  • SW|C.

  • vti_timelastwritten.

  • TX|09.Nov.2003.17:03:06.-0000.

Note

The periods that appear at the end of each line and in some strings are the spaces and line feeds (LF) that appear in this material in its previous format.

Each meta-key appears as a separate bulleted item, followed by another bulleted item that contains the key item. The key item provides coded information about the key, a vertical separation line, and the key value.

For example:

  • vti_webservertype

  • SR|msiis

This example provides information about the vti_webservertype meta-key. In the second bulleted item, the key item, the two-letter code to the left of the vertical line, identifies the data type and the access level of the meta-key value to the right of the vertical line.

Each two-letter code is composed of a single letter for a data type followed by a single letter that denotes an access level. The codes for data types are:

  • B  Boolean value that can be set to true or false. Note that 1 can be used as a substitute for true.

  • F  File system time.

  • I  Integer or signed integer.

  • S  String.

  • T  Time.

  • V  String vector.

The letter codes for the access levels are:

  • R  Can see this key in the user interface (UI) of Microsoft FrontPage but cannot change it.

  • X  Cannot see this key in the FrontPage UI.

  • W  Can see and change this key by using the UI in FrontPage.

Common Field Types

The following table shows common field types used in FrontPage Server Extensions RPC, how they map to .NET data types, and examples of the formatting for each field type.

Name

Format

Example Format

Attachments

System.Boolean

true|false

Boolean

System.Boolean

true|false

Calculated

N/A

N/A

Choice

System.String

String

Computed

N/A

N/A

CrossProjectLink

System.Boolean

true|false

Currency

System.Double

17.57

DateTime

System.DateTime

09.Nov.2004.17:03:06.-0000

Lookup

System.String

A string containing the number ID of the item within the source list.

LookupMulti

System.String

A string containing the number IDs and lookup values of the items within the source list. The string delimits each value by list item ID, semicolons (;), and pound signs (#) in a format like the following:

3;#Value;#2;#Value;#1;#Value

MaxItems

System.Int32

Integer

ModStat

System.Int32

An Integer that equals one of the following values:

0  Approved

1  Denied

2  Pending

MultiChoice

System.String

[Choice Field 1;|\;#Choice 1\;#Choice 2\;#Choice 3\;#]

Note that \;# is used as the separator between multiple values in a choice field with the separator always appearing at the beginning and the end of the field. The semicolon is escaped with a backslash.

Note

System.String

Multiline String

Number

System.Double

1712.5

Recurrence

System.Boolean

true|false

Text

System.String

String

URL

System.String, System.String

_layouts/images/home.gif,Home Page

Note that a comma separates the URL from the description that serves as link text.

User

System.String

DOMAIN\User_Alias