Ansicht
Dokumentation

SO_FOLDER_DELETE_API1 - SAPoffice: Löschen einer Mappe für externe

Vendor Master (General Section)   Addresses (Business Address Services)  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Funktionalität

Dieser Funktionsbaustein ermöglicht das Löschen einer Mappe und ggf. der darin enthaltenen Dokumente und Untermappen. Bei Bedarf werden alle gelöschten Objekte abhänging von der Ablage in den allgemeinen Papierkorb oder in den persönlichen Papierkorb des aktiven Benutzers gestellt und können von dort bis zur nächsten Entleerung zurückgeholt werden.

Importparameter

FOLDER_ID

Objekt-ID der zu löschenden Mappe.

PUT_IN_TRASH

Default = 'X'.

Wenn dieses Flag gesetzt ('X') wird, dann werden die gelöschten Objekte in den entsprechenden Papierkorb gestellt. Bis zur nächsten Entleerung des Papierkorbs können sie von dort zurückgeholt werden.

FORCE_ENTRIES_DELETE

Default = ' '.

Wenn dieses Flag gesetzt ('X') wird, dann werden alle in der angegebenen Mappe enthaltenen Dokumente und Untermappen mitgelöscht. Sofern das Flag nicht gesetzt und die zu löschende Mappe nicht leer ist, wird die Ausnahme FOLDER_NOT_EMPTY ausgelöst.

Ausnahmen

FOLDER_NOT_EMPTY

Die Mappe konnte nicht gelöscht werden, weil in ihr noch Dokumente vorhanden sind. Tritt diese Ausnahme auch bei gesetztem FORCE_ENTRIES_DELETE-Flag auf, konnte ein Dokument in der Mappe oder einer ihrer Untermappen nicht gelöscht werden.

FOLDER_NOT_EXIST

Die angegebene Mappe existiert nicht. Wahrscheinlich wurde entweder eine falsche ID übergeben oder die betroffene Mappe mittlerweile gelöscht.

FOLDER_NO_AUTHORIZATION

Die angegebene Mappe durfte nicht gelöscht werden. Dies kann daran liegen, daß es sich um die persönliche Mappe eines anderen Benutzers oder um eine allgemeine Mappe, für die der Benutzer keine Löschberechtigung besitzt, handelt. Auf den allgemeine Papierkorb darf nur der SAPoffice-Administrator zugreifen.

PARAMETER_ERROR

Es wurde dem Funktionsbaustein eine unzulässige Kombination von Parameterwerten übergeben.

X_ERROR

Es ist ein interner Fehler oder eine Datenbankinkonsistenz aufgetreten.

ENQUEUE_ERROR

Eine am Löschvorgang beteiligte Mappe oder ein zugehörendes Dokument konnte nicht gesperrt werden. Wahrscheinlich findet gerade eine Bearbeitung durch einen anderen Benutzer statt.

Beispiel

Löschen einer Mappe mit evtl. darin vorkommenden Dokumenten. Alle gelöschten Objekte werden in den Papierkorb gelegt. Die ID der zu löschenden Mappe muß von dem aktiven Benutzer eingegeben werden.

PARAMETERS FOLDER_ID LIKE SOOBJINFI1-OBJECT_ID.

CALL FUNCTION SO_FOLDER_DELETE_API1

EXPORTING

FOLDER_ID = FOLDER_ID

PUT_IN_TRASH = 'X'

FORCE_ENTRIES_DELETE = 'X'

EXCEPTIONS

FOLDER_NOT_EXIST = 2

FOLDER_NO_AUTHORIZATION = 3

ENQUEUE_ERROR = 6

OTHERS = 99.

CASE SY-SUBRC.

WHEN 0.

WRITE: / 'Die Mappe wurde erfolgreich gelöscht !'.

WHEN 2.

WRITE: / 'Die angegebene Mappe existiert nicht !'.

WHEN 3.

WRITE: / 'Keine Berechtigung die angegebene Mappe zu löschen !'.

WHEN 6.

WRITE: / 'Die Mappe wird gerade bearbeitet !'.

WHEN 99.

WRITE: / 'Fehler beim Löschen der Mappe aufgetreten !'.

ENDCASE.

Hinweise

Zum Löschen von Dokumenten oder Verteilerlisten müssen die Funktionsbausteine SO_DOCUMENT_DELETE_API1 bzw. SO_DLI_DELETE_API1 verwendet werden.

Weiterführende Informationen

Parameter

FOLDER_ID
FORCE_ENTRIES_DELETE
PUT_IN_TRASH

Ausnahmen

ENQUEUE_ERROR
FOLDER_NOT_EMPTY
FOLDER_NOT_EXIST
FOLDER_NO_AUTHORIZATION
PARAMETER_ERROR
X_ERROR

Funktionsgruppe

SOI1

PERFORM Short Reference   General Material Data  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 4971 Date: 20240523 Time: 113604     sap01-206 ( 64 ms )