Module platformdirs.platforms.windows

win32 miss a library like ctypes, only luajit has require'ffi'

Functions

M.PlatformDirs:new (platformdirs)
M.PlatformDirs.get_home ()
M.PlatformDirs.normpath (path)
M.PlatformDirs:expand_user (path)
M.PlatformDirs:append_app_name_and_version (base, ...)

user/site directories

M.PlatformDirs:user_data_dir () C:\Users\$USER\AppData\Local\$author\$app\$version
M.PlatformDirs:site_data_dir () C:\ProgramData\$author\$app\$version
M.PlatformDirs:user_cache_dir () C:\Users\$USER\AppData\Local\$author\$app\Caches\$version
M.PlatformDirs:site_cache_dir () C:\ProgramData\$author\$app\Cache\$version
M.PlatformDirs:user_log_dir () C:\Users\$USER\AppData\Local\$author\$app\$version\Logs
M.PlatformDirs:user_runtime_dir () C:\Users\$USER\AppData\Local\Temp\$author\$app\$version

user directories

M.PlatformDirs:user_documents_dir () C:\Users\$USER\Documents
M.PlatformDirs:user_downloads_dir () C:\Users\$USER\Downloads
M.PlatformDirs:user_pictures_dir () C:\Users\$USER\Pictures
M.PlatformDirs:user_videos_dir () C:\Users\$USER\Videos
M.PlatformDirs:user_music_dir () C:\Users\$USER\Music
M.PlatformDirs:user_desktop_dir () C:\Users\$USER\Desktop


Functions

M.PlatformDirs:new (platformdirs)

Parameters:

  • platformdirs table?

Returns:

    table platformdirs
M.PlatformDirs.get_home ()

Returns:

    string
M.PlatformDirs.normpath (path)

Parameters:

  • path string

Returns:

    string
M.PlatformDirs:expand_user (path)

Parameters:

  • path string

Returns:

    string
M.PlatformDirs:append_app_name_and_version (base, ...)

Parameters:

  • base string
  • ... string

Returns:

    string

user/site directories

M.PlatformDirs:user_data_dir ()
C:\Users\$USER\AppData\Local\$author\$app\$version

Returns:

    string
M.PlatformDirs:site_data_dir ()
C:\ProgramData\$author\$app\$version

Returns:

    string
M.PlatformDirs:user_cache_dir ()
C:\Users\$USER\AppData\Local\$author\$app\Caches\$version

Returns:

    string
M.PlatformDirs:site_cache_dir ()
C:\ProgramData\$author\$app\Cache\$version

Returns:

    string
M.PlatformDirs:user_log_dir ()
C:\Users\$USER\AppData\Local\$author\$app\$version\Logs

Returns:

    string
M.PlatformDirs:user_runtime_dir ()
C:\Users\$USER\AppData\Local\Temp\$author\$app\$version

Returns:

    string

user directories

M.PlatformDirs:user_documents_dir ()
C:\Users\$USER\Documents

Returns:

    string
M.PlatformDirs:user_downloads_dir ()
C:\Users\$USER\Downloads

Returns:

    string
M.PlatformDirs:user_pictures_dir ()
C:\Users\$USER\Pictures

Returns:

    string
M.PlatformDirs:user_videos_dir ()
C:\Users\$USER\Videos

Returns:

    string
M.PlatformDirs:user_music_dir ()
C:\Users\$USER\Music

Returns:

    string
M.PlatformDirs:user_desktop_dir ()
C:\Users\$USER\Desktop

Returns:

    string
generated by LDoc 1.5.0 Last updated 2025-12-25 12:32:44