Share via

Return Value

  • Article

Successful Return Values

A server extensions successful return value can contain either or both of the following:

  • A message that the method completed successfully.
  • The method's name and a bulleted list of meta info keys and their values for the page, set of pages, or Web site upon which the method acted.

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:4.0.1.2207LF <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;.4.0.ProgId.FrontPage.
Editor.Document.LF<li>vti_progidLF<li>SR|FrontPage Editor DocumentLF
<li>vti_generatorLF<li>SR|Microsoft FrontPage 4.0LF
<li>vti_nexttolasttimemodifiedLF<li>TR|05 Nov 1998 22:23:21 -0000 
LF<li>vti_themeaggregateLF<li>SR|defaultLF<li>vti_navbitsLF
<li>SW|CLF<li>vti_timelastwrittenLF<li>TX|09 Nov 1998 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:4.0.1.2207.

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.1998.22:23:06.-0000.
● vti_timelastmodified.
● TR|09.Nov.1998.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\.4.0.ProgId.FrontPage.Editor.Document.
● vti_progid.
● SR|FrontPage.Editor.Document.
● vti_generator.
● SR|Microsoft.FrontPage.4.0.
● vti_nexttolasttimemodified.
● TR|05.Nov.1998.22:23:21.-0000.
● vti_themeaggregate.
● SR|default.
● vti_navbits.
● SW|C.
● vti_timelastwritten.
● TX|09.Nov.1998.17:03:06.-0000.

Note that 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 name 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 key vti_webservertype. 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 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, has a value of "true" or "false". Note that "1" can be used as a substitute for "true".
  • F - File system time.
  • I - Integer, signed integer. 
  • S - String.
  • T - Time.
  • V - String vector.

The letter codes for the access levels are:

  • R - FrontPage user can see this key in the user interface (UI), but cannot change it.
  • X - FrontPage user cannot see this key in the UI.
  • W - FrontPage client can see and change this key via the UI.