ISPStsadmCommand.GetHelpMessage - Méthode

Article
10/14/2015

Obtient une remarque à propos de la syntaxe de l'opération personnalisée spécifiée. Cette méthode est désapprouvée et ne peut pas pris en charge dans les futures versions de . Pour les opérations de ligne de commande personnalisée, consultez l'espace de noms Microsoft.SharePoint.PowerShell .

Espace de noms : Microsoft.SharePoint.StsAdmin
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Function GetHelpMessage ( _
    command As String _
) As String
'Utilisation
Dim instance As ISPStsadmCommand
Dim command As String
Dim returnValue As String

returnValue = instance.GetHelpMessage(command)

string GetHelpMessage(
    string command
)

Paramètres

command
Type : System.String

L'opération sur laquelle l'aide est demandée.

Valeur renvoyée

Type : System.String
String qui représente une description de la syntaxe de l' opération command.

Remarques

Avertissement

Cette méthode est documentée uniquement pour fournir une assistance au dépannage des extensions existantes de STSADM.EXE. Ne créez pas de nouvelles extensions. Au lieu de cela, étendre PowerShell. Consultez l'espace de noms Microsoft.SharePoint.PowerShell .

GetHelpMessage est appelé lorsque l'utilisateur tape la commande suivante à l'invite du système, où myOperation est le nom de votre opération personnalisée.

stsadm -help myOperation

Le message d'aide s'affiche dans la console.

GetHelpMessage est également appelée lorsque Run renvoie SyntaxError().

Le String retourné est généralement la seule aide sur la syntaxe disponible pour les utilisateurs de l'opération command . Ainsi, tout ce dont il a besoin de connaître, inclure, y compris les paramètres possibles, le cas échéant, qui peut être utilisé avec l'opération.

Utilisez style de conseils de syntaxe standard.

Utilisez "[" et "]" pour indiquer le matériau est facultative.
Utilisez "{" et "}" pour indiquer les matières requises.
Lorsque plus d'un paramètre peut être utilisé, utilisez « | » pour séparer les alternatives.
Variables doivent être entourés de « < » et « > ».

La chaîne suivante est automatiquement ajoutée à la valeur de retour ; ne le définissez pas explicitement.

"stsadm -o command \n"

Le command est le nom de votre opération personnalisée.

Par exemple, voici le message retourné par stsadm -help activatefeature. Notez l'utilisation de la mise en retrait pour améliorer la lisibilité.

stsadm -o activatefeature
       {-filename <relative path to Feature.xml> |
        -name <feature folder> |
        -id <feature Id>}
       [-url <url>]
       [-force]

Exemples

L'exemple suivant montre une implémentation de GetHelpMessage pour une opération simple qui prend un paramètre nommé « url ». Notez que dans la mesure où la classe personnalisée dans cet exemple crée uniquement une nouvelle opération, la méthode n'a pas besoin de lire le paramètre command . Si plus d'une nouvelle opération ont été définie, la méthode requiert une structure RAMIFIÉS en fonction de la valeur de command.

using System;
using System.Collections.Specialized;
using System.Text;
using Microsoft.SharePoint;
using Microsoft.SharePoint.StsAdmin;

namespace MS.Samples.SharePoint
{
    public class SimpleCommandHandler : ISPStsadmCommand
    {
        public string GetHelpMessage(string command)
        {
            // "stsadm -o command \n" is prepended here.
            return "-url <full url to a site in SharePoint>";
        }

    // Run() implementation not shown.

    }
}

Imports System 
Imports System.Collections.Specialized 
Imports System.Text 
Imports Microsoft.SharePoint 
Imports Microsoft.SharePoint.StsAdmin 

Namespace MS.Samples.SharePoint 
    Public Class SimpleCommandHandler 
        Implements ISPStsadmCommand 
        Public Function GetHelpMessage(ByVal command As String) As String 
            ' "stsadm -o command \n" is prepended here. 
            Return "-url <full url to a site in SharePoint>" 
        End Function 
        
        ' Run() implementation not shown. 
        
    End Class 
End Namespace