GET_DESKTOP_DIRECTORY

Retrieves the folder, which contains the objects displayed on the desktop of the client computer.

Caution Caution

Call CL_GUI_CFW=>FLUSH in the ABAP program after calling this method to actually execute the method on the client.

End of the caution.

Caution Caution

Do not use this function! Files should not be stored on the desktop of the client PC. Use either the temporary directory (-> GET_TEMP_DIRECTORY) or the document directory (-> GET_SAPGUI_WORKDIR) instead! In addition, the returned directory is not guaranteed to be the desktop directory.

End of the caution.

Argument

[CHANGING] desktop_directory TYPE STRING

Directory in which objects displayed on desktop are located. The Windows GUI will return the directory in which the objects on the desktop are located, the Web GUI returns the current directory.

Note Note

This parameter should have been defined as an exporting parameter because the content passed to the method will be ignored.

End of the note.

Exceptions

`CNTL_ERROR`	This exception is raised, if the directory could not be determined.
`ERROR_NO_GUI`	Currently not used.
`NOT_SUPPORTED_BY_GUI`	Thrown if neither Windows nor Web GUI is being used.