SPCmdlet-Member
Stellt eine abstrakte Basisklasse für alle benutzerdefinierten Cmdlets, die geschrieben werden, in der SharePoint-Bereitstellungen, Bereitstellung einheitliches Verhalten für alle SharePoint-Cmdlets verwendet werden.
Der SPCmdlet-Typ macht die folgenden Member verfügbar.
Konstruktoren
Name | Beschreibung | |
---|---|---|
SPCmdlet | Wenn Sie in der abgeleiteten Klasse überschrieben, initialisiert dieser Konstruktor eine neue Instanz der abgeleiteten Klasse. |
Oben
Eigenschaften
Name | Beschreibung | |
---|---|---|
AssignmentCollection | Dient zum Abrufen oder Festlegen des SPAssignmentCollection -Objekts, das die Cmdlet-Pipelines für die Verwendung mit dem letzten Befehl übergeben wird. | |
CommandOrigin | (Geerbt von InternalCommand.) | |
CommandRuntime | (Geerbt von Cmdlet.) | |
ConfirmationMessage | Dient zum Abrufen oder festlegen eine Nachricht, die mit der Benutzer zur Bestätigung aufgefordert wird. | |
CurrentPSTransaction | (Geerbt von Cmdlet.) | |
DisposeOutputObjects | Dient zum Abrufen oder Festlegen eines booleschen Werts, das angibt, ob die Basisklasse Ausgabe-Objekte verwerfen wird, nachdem sie ausgegeben wurde, haben. | |
Events | (Geerbt von PSCmdlet.) | |
Fields | Eine Eigenschaftensammlung, die die öffentlichen Eigenschaften des Cmdlets enthält. | |
Host | (Geerbt von PSCmdlet.) | |
InvokeCommand | (Geerbt von PSCmdlet.) | |
InvokeProvider | (Geerbt von PSCmdlet.) | |
JobRepository | (Geerbt von PSCmdlet.) | |
MyInvocation | (Geerbt von PSCmdlet.) | |
ParameterSetName | (Geerbt von PSCmdlet.) | |
SessionState | (Geerbt von PSCmdlet.) | |
Stopping | (Geerbt von Cmdlet.) |
Oben
Methoden
Name | Beschreibung | |
---|---|---|
BeginProcessing | Legt beginnen Markierungen für die Ausführung des Cmdlets, während der Verarbeitungsschritte wie Protokollierung und Berechtigung Überprüfungen durchgeführt werden. Diese Methode wird einmal am Anfang des Cmd Ausführung aufgerufen. (Überschreibt CmdletBeginProcessing().) | |
CurrentProviderLocation | (Geerbt von PSCmdlet.) | |
EndProcessing | Bietet eine Möglichkeit zum Hinzufügen von Nachbearbeitung Funktionalität für das Cmdlet. (Überschreibt CmdletEndProcessing().) | |
Equals | (Geerbt von Object.) | |
Finalize | (Geerbt von Object.) | |
GetHashCode | (Geerbt von Object.) | |
GetProp<T> | Ruft das Objekt aus der Fields-Eigenschaft, die der angegebene Feldname zugeordnet ist. | |
GetPropV<S> | Ruft die Struktur aus Fields -Eigenschaft, die der angegebene Feldname zugeordnet ist. | |
GetResolvedProviderPathFromPSPath | (Geerbt von PSCmdlet.) | |
GetResourceString | (Geerbt von Cmdlet.) | |
GetSwitch | Ruft ein SwitchParameter -Objekt, wenn eine gefunden wird. | |
GetType | (Geerbt von Object.) | |
GetUnresolvedProviderPathFromPSPath | (Geerbt von PSCmdlet.) | |
GetVariableValue(String) | (Geerbt von PSCmdlet.) | |
GetVariableValue(String, Object) | (Geerbt von PSCmdlet.) | |
InternalBeginProcessing | Diese Methode führt innerhalb der BeginProcessing() -Methode und vor der Pipeline-Parameter auf-Methode festgelegt werden, und daher bietet eine Möglichkeit für Benutzer, die BeginProcessing() -Methode Programmfunktionen hinzu. | |
InternalDispose | Liefert erbende Klassen Bereinigungscode, um Objekte verwerfen, die mithilfe der Methods InternalValidate(), ConfirmationMessageoder InternalProcessRecord() erstellt wurden. | |
InternalEndProcessing | Diese Methode innerhalb der EndProcessing() -Methode ausgeführt wird, und daher bietet eine Möglichkeit für Benutzer, die EndProcessing() -Methode nach Abschluss der Ausführung des Cmdlets Programmfunktionen hinzuzufügen. | |
InternalProcessRecord | Bietet eine Möglichkeit für Benutzer, die Funktion ProcessRecord() Programmfunktionen hinzuzufügen. | |
InternalStopProcessing | Bietet eine Möglichkeit für Benutzer, die Funktion StopProcessing() Programmfunktionen hinzuzufügen. | |
InternalValidate | Bietet eine Möglichkeit zum Validieren von Benutzereingaben während der Ausführung der ProcessRecord() -Methode. | |
Invoke | (Geerbt von Cmdlet.) | |
MemberwiseClone | (Geerbt von Object.) | |
ProcessRecord | Der Datensatz-Verarbeitungsfunktionalität für das Cmdlet bietet und protokolliert Einträge für die Ausführung von jedem Datensatz. Diese Methode wird einmal für jedes weitergeleitete Objekt aufgerufen (d. h., für jeden Datensatz). (Überschreibt CmdletProcessRecord().) | |
RequireLocalFarmExist | Dient zum Abrufen oder Festlegen eines booleschen Werts, das angibt, ob eine lokale Farm vorhanden sein muss, bevor das Cmdlet ausgeführt werden kann. | |
RequireUserFarmAdmin | Gibt an, ob ein Cmdlet auf Farmebene Administratorrechte zum Ausführen von benötigen. | |
RequireUserMachineAdmin | Gibt an, ob ein Cmdlet Administratorrechte auf dem Computer, auf denen er ausgeführt wird. | |
SetProp | Nur zur internen Verwendung. Verwenden Sie nicht. | |
ShouldContinue(String, String) | (Geerbt von Cmdlet.) | |
ShouldContinue(String, String, Boolean, Boolean) | (Geerbt von Cmdlet.) | |
ShouldProcess(String) | (Geerbt von Cmdlet.) | |
ShouldProcess(String, String) | (Geerbt von Cmdlet.) | |
ShouldProcess(String, String, String) | (Geerbt von Cmdlet.) | |
ShouldProcess(String, String, String, ShouldProcessReason) | (Geerbt von Cmdlet.) | |
SkipProcessCurrentRecord | Bietet eine Möglichkeit zum Beenden der Verarbeitung eines bestimmten Datensatzes und zum Überspringen diesen Datensatzes zum nächsten. | |
StopProcessing | Beendet tragen Verarbeitung in Fällen, in denen der Benutzer das Cmdlet asynchron beendet. Diese Methode wird von PowerShell aufgerufen, wenn der Benutzer die Tasten Strg + C. eintritt (Überschreibt CmdletStopProcessing().) | |
ThrowTerminatingError(ErrorRecord) | (Geerbt von Cmdlet.) | |
ThrowTerminatingError(Exception, ErrorCategory, Object) | Gibt die Details eines Fehlers Abbruch auf dem Bildschirm als Fehlermeldung und protokolliert die Details in der Protokolldatei. | |
ThrowTerminatingError(Exception, ErrorCategory, Object, String) | Gibt die Details eines Fehlers Abbruch auf dem Bildschirm als Fehlermeldung und protokolliert die Details in der Protokolldatei. | |
ToString | (Geerbt von Object.) | |
TransactionAvailable | (Geerbt von Cmdlet.) | |
WriteCommandDetail | (Geerbt von Cmdlet.) | |
WriteDebug | (Geerbt von Cmdlet.) | |
WriteError(ErrorRecord) | (Geerbt von Cmdlet.) | |
WriteError(Exception, ErrorCategory, Object) | Gibt die Details der Fehler nicht zum Abbruch auf dem Bildschirm als Fehlermeldung und protokolliert die Details in der Protokolldatei. | |
WriteError(Exception, ErrorCategory, Object, String) | Gibt die Details der Fehler nicht zum Abbruch auf dem Bildschirm als Fehlermeldung und protokolliert die Details in der Protokolldatei. | |
WriteObject(Object) | (Geerbt von Cmdlet.) | |
WriteObject(Object, Boolean) | (Geerbt von Cmdlet.) | |
WriteProgress(ProgressRecord) | (Geerbt von Cmdlet.) | |
WriteProgress(String, String) | Schreibt Fortschrittsinformationen auf dem Bildschirm zu im Zusammenhang mit dem Cmdlet ausführen. | |
WriteProgress(String, String, Int32) | Schreibt Fortschrittsinformationen auf dem Bildschirm zu im Zusammenhang mit dem Cmdlet ausführen. | |
WriteResult | Zeigt eine Objektinstanz und schreibt sie auf dem Konsolenbildschirm oder in der Pipeline Cmdlet. | |
WriteVerbose | (Geerbt von Cmdlet.) | |
WriteWarning(String) | (Geerbt von Cmdlet.) | |
WriteWarning(String, String) | Bietet eine Möglichkeit zum Anzeigen von dem Benutzer einer Warnmeldung angezeigt. |
Oben