powcshell.shelllibrary module

目次

powcshell.shelllibrary module#

シェルライブラリ。

主なクラスは ShellLibrary です。

class powcshell.shelllibrary.DefaultSaveFolderType(*values)#

ベースクラス: IntEnum

DEFAULTSAVEFOLDERTYPE

DETECT = 1#
PRIVATE = 2#
PUBLIC = 3#
class powcshell.shelllibrary.IShellLibrary#

ベースクラス: IUnknown

AddFolder = <COM method offset 5: WinFunctionType>#
Commit = <COM method offset 17: WinFunctionType>#
GetDefaultSaveFolder = <COM method offset 9: WinFunctionType>#
GetFolderType = <COM method offset 13: WinFunctionType>#
GetFolders = <COM method offset 7: WinFunctionType>#
GetIcon = <COM method offset 15: WinFunctionType>#
GetOptions = <COM method offset 11: WinFunctionType>#
LoadLibraryFromItem = <COM method offset 3: WinFunctionType>#
LoadLibraryFromKnownFolder = <COM method offset 4: WinFunctionType>#
RemoveFolder = <COM method offset 6: WinFunctionType>#
ResolveFolder = <COM method offset 8: WinFunctionType>#
Save = <COM method offset 18: WinFunctionType>#
SaveInKnownFolder = <COM method offset 19: WinFunctionType>#
SetDefaultSaveFolder = <COM method offset 10: WinFunctionType>#
SetFolderType = <COM method offset 14: WinFunctionType>#
SetIcon = <COM method offset 16: WinFunctionType>#
SetOptions = <COM method offset 12: WinFunctionType>#
class powcshell.shelllibrary.LibraryFolderFilter(*values)#

ベースクラス: IntEnum

LIBRARYFOLDERFILTER

ALL_ITEMS = 3#
FORCE_FILESYSTEM = 1#
STORAGE_ITEMS = 2#
class powcshell.shelllibrary.LibraryOptionFlag(*values)#

ベースクラス: IntFlag

LIBRARYOPTIONFLAGS

ALL = 1#
DEFAULT = 0#
PINNED_TO_NAVPANE = 1#
class powcshell.shelllibrary.LibrarySaveFlag(*values)#

ベースクラス: IntFlag

LIBRARYSAVEFLAGS

FAIL_IF_THERE = 0#
MAKE_UNIQUE_NAME = 2#
OVERRIDE_EXISTING = 1#
class powcshell.shelllibrary.ShellLibrary(o: Any)#

ベースクラス: object

シェルライブラリ。IShellLibraryインターフェイスのラッパーです。

add_folder(item: ShellItem) → None#
add_folder_nothrow(item: ShellItem) → ComResult[None]#
add_folderpath(path: str | PathLike) → None#
add_folderpath_nothrow(path: str | PathLike) → ComResult[None]#
commit() → None#
commit_nothrow() → ComResult[None]#
static create() → ShellLibrary#
property defaultsavefolder_detect: ShellItem2#
property defaultsavefolder_detect_nothrow: ComResult[ShellItem2]#
property defaultsavefolder_private: ShellItem2#
property defaultsavefolder_private_nothrow: ComResult[ShellItem2]#
property defaultsavefolder_public: ShellItem2#
property defaultsavefolder_public_nothrow: ComResult[ShellItem2]#
property folders_all: ShellItemArray#
property folders_all_nothrow: ComResult[ShellItemArray]#
property folders_filesys: ShellItemArray#
property folders_filesys_nothrow: ComResult[ShellItemArray]#
property folders_storage: ShellItemArray#
property folders_storage_nothrow: ComResult[ShellItemArray]#
property foldertype: GUID#

フォルダの種類（FolderTypeID定数）を取得または設定します。

property foldertype_nothrow: ComResult[GUID]#

フォルダの種類（FolderTypeID定数）を取得します。

get_defaultsavefolder(folder_type: DefaultSaveFolderType) → ShellItem2#
get_defaultsavefolder_nothrow(folder_type: DefaultSaveFolderType) → ComResult[ShellItem2]#
get_folders(filter: LibraryFolderFilter | int) → ShellItemArray#

ライブラリに含まれるサブフォルダのセットを取得します。

戻り値のwrapped_interfaceはCShellItemArrayの実装するインターフェイス（IObjectCollection、IObjectArray）に変換可能です。

get_folders_nothrow(filter: LibraryFolderFilter | int) → ComResult[ShellItemArray]#

ライブラリに含まれるサブフォルダのセットを取得します。

戻り値のwrapped_interfaceはCShellItemArrayの実装するインターフェイス（IObjectCollection、IObjectArray）に変換可能です。

property icon: str#
property icon_nothrow: ComResult[str]#
static load_fromitem(item: ShellItem, mode: StorageMode | int) → ShellLibrary#
static load_fromknownfolder(folder_id: KnownFolderID, mode: StorageMode | int) → ShellLibrary#
static load_fromparsingname(name: str | PathLike, mode: StorageMode | int) → ShellLibrary#
load_libfromitem(item: ShellItem, mode: StorageMode | int) → None#
load_libfromitem_nothrow(item: ShellItem, mode: StorageMode | int) → ComResult[None]#
load_libfromknownfolder(folder_id: KnownFolderID, mode: StorageMode | int) → None#
load_libfromknownfolder_nothrow(folder_id: KnownFolderID, mode: StorageMode | int) → ComResult[None]#
property options: LibraryOptionFlag#
property options_nothrow: ComResult[LibraryOptionFlag]#
property pinnedtonavbar: bool#
property pinnedtonavbar_nothrow: ComResult[bool]#
remove_folder(item: ShellItem) → None#
remove_folder_nothrow(item: ShellItem) → ComResult[None]#
remove_folderpath(path: str | PathLike) → None#
remove_folderpath_nothrow(path: str | PathLike) → ComResult[None]#
resolve_folder(folder_to_resolve: ShellItem, timeout: int) → ShellItem2#
resolve_folder_nothrow(folder_to_resolve: ShellItem, timeout: int) → ComResult[ShellItem2]#
save(folder_to_save_in: ShellItem | None, lib_name: str, flags: LibrarySaveFlag | int) → ShellItem2#

ライブラリを保存します。既定の場所（FOLDERID_Libraries）に保存する場合はfolder_to_save_inをNoneにします。

save_infolderpath(path: str | PathLike, lib_name: str, flags: LibrarySaveFlag) → str#
save_infolderpath_nothrow(path: str | PathLike, lib_name: str, flags: LibrarySaveFlag) → ComResult[str]#
save_inknownfolder(folder_id_to_save_in: KnownFolderID, lib_name: str, flags: LibrarySaveFlag | int) → ShellItem2#
save_inknownfolder_nothrow(folder_id_to_save_in: KnownFolderID, lib_name: str, flags: LibrarySaveFlag | int) → ComResult[ShellItem2]#
save_nothrow(folder_to_save_in: ShellItem | None, lib_name: str, flags: LibrarySaveFlag | int) → ComResult[ShellItem2]#

ライブラリを保存します。既定の場所（FOLDERID_Libraries）に保存する場合はfolder_to_save_inをNoneにします。

set_defaultsavefolder(folder_type: DefaultSaveFolderType, item: ShellItem) → None#
set_defaultsavefolder_detect_nothrow(item: ShellItem) → ComResult[None]#
set_defaultsavefolder_nothrow(folder_type: DefaultSaveFolderType, item: ShellItem) → ComResult[None]#
set_defaultsavefolder_private_nothrow(item: ShellItem) → ComResult[None]#
set_defaultsavefolder_public_nothrow(item: ShellItem) → ComResult[None]#
set_foldertype_nothrow(value: GUID) → ComResult[None]#

フォルダの種類（FolderTypeID定数）を設定します。

set_icon_nothrow(value: str) → ComResult[None]#
set_options(mask: LibraryOptionFlag | int, options: LibraryOptionFlag | int) → None#
set_options_nothrow(mask: LibraryOptionFlag | int, options: LibraryOptionFlag | int) → ComResult[None]#
set_pinnedtonavbar_nothrow(value: bool) → ComResult[None]#
property wrapped_obj: c_void_p#
目次