Sintaxe do método

Artigo
11/27/2008

Cada tópico método inclui uma seção sintaxe que descreve a forma geral de chamar o método. Para obter orientação sobre como para formato posteriormente um método em uma postagem, consulte "Formulário de um POST command" neste tópico.

Há duas maneiras para comandos postagem usando o remoto protocolo chamar (RPC) procedimento de Windows SharePoint Services. Você pode comandos único postagem por incorporação-los em um URL, ou você podem usar a funcionalidade lote de Collaborative Application Markup Language (CAML) para enviar solicitações múltiplo por transação.

Incorporando um método em um URL

Por incorporação uma solicitação em um URL é possível emitir um método e os parâmetros desejados para um servidor que esteja execução Windows SharePoint Services. A sintaxe é:

                    http://[site_name]/_vti_bin/owssvr.dll?Cmd=Method_name[&Parameter1=Value1&Parameter2=Value2...]

Para obter mais informações, consulte Protocolo URL.

Usando a funcionalidade de lote CAML para enviar múltiplas solicitações

Emitir um comando por Post requer muitas Trips custosa arredondar para o servidor. Para reduzir o número de arredondar viagens, use o elemento em lote CAML para emitir comandos múltiplo por solicitação HTTP. Todas as solicitações devem incluir um de alto nível 9019ce72-f6a6-43a9-ade5-5c8542c3ba97 comando DisplayPost. A sintaxe usada no POST URL para todas as solicitações método para Windows SharePoint Services é da seguinte maneira:

                    POST /[Path]/[Subsite]/_vti_bin/owssvr.dll?Cmd=DisplayPost

Observação

Quando a solicitação não é emitida por um proxy, você deve postagem diretamente para o servidor-URL relativa do recurso.O nome do host não é parte de um servidor-URL relativa.

A sintaxe para emissão múltiplo solicitações em Windows SharePoint Services é da seguinte maneira:

                    POST /[Path/][Subweb/]_vti_bin/_vti_aut/owssvr.dll?Cmd=DisplayPost
<?xml version="1.0" encoding="UTF-8"?>
<ows:Batch OnError="Return">
  <Method ID="String">
    <SetVar name="Cmd">Method1_name</SetVar>
    <SetVar name="Parameter1">Value1</SetVar>
      .
      .
      .
    <SetVar name="ParameterN">ValueN</SetVar>
  </Method>
  <Method ID="String">
    <SetVar name="Cmd">Method2_name</SetVar>
    <SetVar name="Parameter1">Value1</SetVar>
      .
      .
      .
    <SetVar name="ParameterN">ValueN</SetVar>
  </Method>
      .
      .
      .
  <Method ID="String">
    <SetVar name="Cmd">MethodN_name</SetVar>
    <SetVar name="Parameter1">Value1</SetVar>
      .
      .
      .
    <SetVar name="ParameterN">ValueN</SetVar>
  </Method>
</ows:Batch>

No seguinte exemplo, a em lote elemento é usado para criar dois personalizado lista nomeado tópicos da reunião e voluntários.

                    POST /STSServer1/_vti_bin/_vti_aut/owssvr.dll?Cmd=DisplayPost

<?xml version="1.0" encoding="UTF-8"?>
<ows:Batch OnError="Return"> 
  <Method ID="0,NewList"> 
    <SetVar name="Cmd">NewList</SetVar> 
    <SetVar name="ListTemplate">100</SetVar> 
    <SetVar name="Title">Meeting Topics</SetVar> 
  </Method>
  <Method ID="1,NewList"> 
    <SetVar name="Cmd">NewList</SetVar> 
    <SetVar name="ListTemplate">100</SetVar> 
    <SetVar name="Title">Volunteers</SetVar> 
  </Method> 
</ows:Batch>

Sintaxe de um comando POST para as Extensões de Servidor FrontPage de Microsoft

Cada método é composto de nome de método seguido um dois-pontos (:) e um espaço. Em seguida vem o server_extension_version para as Extensões de Servidor FrontPage e, em seguida, os parâmetros para o método. Each parameter name has an ampersand (&) as its first character, and the parameter name is followed immediately by an equal sign (=) without spaces before it. O sinal de igualdade é seguido imediatamente o valor do parâmetro. Por exemplo:

                    &service_name=/fodo4

Valores de parâmetro usam o seguinte convenções:

Fonte/código	Significado	Exemplo
Itálico	Variável	nome_do_serviço
Angle brackets (< >)	De conteúdo opcional	<platform=os>
Texto sem formatação	Literais	método
Símbolo disjuntiva (\|)	Separates igual alternativo opções	(VERDADEIRO \| FALSO)

Para obter informações sobre parâmetros, consulte o Parâmetros parâmetros seção da página de referência para o método específico.

A maioria dos comandos POST no protocolo RPC para FrontPage Server Extensions levar esta forma:

                    POST /directory_name/_vti_bin/_vti_aut/program_name.dll.
HTTP/1.0..Date:.Thu,.03.Dec.1998.19:09:16.GMT..

No exemplo anterior, directory_name é o nome do Diretório a raiz do site, e nome_do_programa é o nome do programa em FrontPage Server Extensions para que o comando POST é endereçado.

O seqüência de caracteres de data é seguido HTTP cabeçalho linhas conforme ilustrado no próximo exemplo:

                    MIME-Version:.1.0..User-Agent:.client_name/version..
Host:.host_name..Accept:.auth/sicily..
Authorization:.Basic.cm9iZjpUS3NvKjUw.
Content-Length:.64..
Content-Type:.application/x-www-form-urlencoded
X-Vermeer-Content-Type:.application/x-www-form-urlencoded
.
.
.

Essas linhas identificam o aplicativo cliente responsável o comando POST, o tamanho e tipo do comando POST, as well as informações de segurança. Especificar o cabeçalho X-Vermeer-Content-Type as in de exemplo é exigido. Terceiro-parte desenvolvedores que criam aplicativos que usam métodos RPC para interação com Windows SharePoint Services deve incluir este cabeçalho em seus POSTs. Se o cabeçalho não estiver incluído, a operação RPC falhará.

A última parte o comando POST contém o método com qualquer selecionado parâmetros e seus valores. Por exemplo:

                    method=open+service%3a4%2e0%2e1%2e2207&service%5fname=%2fallnew.

Forma de um comando POST

A primeira linha de um comando POST contém o comando POST e a versão HTTP em uso. O comando POST é seguido por vários cabeçalhos HTTP, algumas das que são padrão e algumas das qual são exclusivo para FrontPage Server Extensions. Um comando POST típico esta aparência:

                    POST /allnew/_vti_bin/_vti_aut/author.dll HTTP/1.0CRLF
Date: Thu, 03 Dec 1998 19:09:16 GMTCRLF
MIME-Version: 1.0CRLF
User-Agent: MSFrontPage/4.0CRLF
Host: seattleCRLF
Accept: auth/sicilyCRLF
Authorization: Basic cm9iZjpUS3NvKjUwCRLF
Content-Length: 343CRLF
Content-Type: application/x-www-form-urlencodedCRLF
X-Vermeer-Content-Type: application/x-www-form-urlencodedCRLF
CRLF
method=list+documents%3a4%2e0%2e1%2e2207&service%5fname=%2fallnew
&listHiddenDocs=false&listExplorerDocs=false&listRecurse=false&listFiles=true
&listFolders=true&listLinkInfo=true&listIncludeParent=true&listDerived=false
&listBorders=false&listChildWebs=true&initialUrl=&platform=WinI386
&folderList=%5b%3bTW%7c09+Nov+1998+17%3a03%3a25+%2d0000%5dLF

Cada linha cabeçalho e o linha de comando POST devem terminar em um retorno de carro/alimentação de linha ( CRLF). Observe que o CRLF é a seqüência de bytes 0x0D, 0x0A, in accordance with o protocolo HTTP.

Observação

Para obter mais informações sobre o comando POST e cabeçalhos HTTP, consulte a especificação 1.0 HTTP no página da Web de W3C (World Wide Web Consortium).Essa especificação é usada pelo protocolo de RPC.

Após os cabeçalhos um CRLF, seguido de método protocolo RPC que está sendo enviado para FrontPage Server Extensions. Codifica espaços o método como o caractere Plus assinar (+). Codificar caracteres não-alfanumérico no método usando codificação %XX % xx (de instância, a barra invertida é codificada como c %5). Adicione um alimentação de linha ( LF) ao final dos dados de método.

Forma de uma resposta para um comando POST

Quando um aplicativo cliente envia um método para as Extensões de Servidor FrontPage usando um comando POST, as Extensões de Servidor FrontPage envia voltar um padrão HTTP OK para recebimento confirmação do método. As Extensões de Servidor FrontPage responde para o método enviando uma página HTML codificada para o aplicativo cliente. O seguinte exemplo mostra uma resposta típica:

                    Content-type: application/x-vermeer-rpc..X-FrontPage-User-Name:
usernameCRLF
CRLF
<html><head><title>vermeer.RPC 
packet</title></head>LF<body>.
LF<p>method=list documents: 
6.0.x.xxxxLF<p>document_list=
LF<ul>
LF<ul>LF<li>document_name=Default.htm
LF<li>meta_info=
LF<ul>
LF<li>vti_author
LF<li>SR|author
LF<li>vti_title
LF<li>SW|Home Page
LF<li>vti_timecreated
LF<li>TR|10 Sep 1998 10:07:54 -0700
LF<li>vti_filesize
LF<li>IX|277
LF<li>vti_modifiedby
LF<li>SR|author
LF<li>vti_nexttolasttimemodified
LF<li>TR|10 Sep 1998 10:07:54 -0700
LF<li>vti_timelastmodified
LF<li>TR|10 Sep 1998 10:07:55 -0700
LF<li>vti_timelastwritten
LF<li>TX|10 Sep 1998 10:07:56 -0700
LF</ul>
LF</ul>
LF<ul>
LF<li>document_name=new1.htm
LF<li>meta_info=
LF<ul>
LF<li>vti_author
LF<li>SR|IUSR_author
. 
. 
.
</body>
</html>

Há três variações possíveis para respostas. Primeiro, a resposta é um página HTML que inclui apenas uma mensagem sobre o êxito ou falha do método. Em segundo lugar, a resposta é um página HTML que inclui apenas meta-informações sobre o objeto do método. Em terceiro lugar, a resposta inclui uma mensagem e meta-informações.

Em todas as variações, a resposta começa com um cabeçalho Content_type. The HTML page that follows must have a line-feed (LF) before each of these HTML tags: <p>, <li>, <ul>, and </ul>.

For information about how responses are documented, see Valores Return.