:py:mod:`dissect.target.plugins.os.windows.lnk`
===============================================

.. py:module:: dissect.target.plugins.os.windows.lnk




Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.windows.lnk.LnkPlugin



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.plugins.os.windows.lnk.parse_lnk_file



Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.windows.lnk.LnkRecord


.. py:data:: LnkRecord

.. py:function:: parse_lnk_file(target: dissect.target.target.Target, lnk_file: dissect.shellitem.lnk.Lnk, lnk_path: dissect.target.helpers.fsutil.TargetPath) -> LnkRecord

.. py:class:: LnkPlugin(target: dissect.target.target.Target)

   Bases: :py:obj:`dissect.target.plugin.Plugin`


   Windows lnk plugin.


   .. py:attribute:: folders
      :value: ['programdata', 'users', 'windows']



   .. py:method:: check_compatible() -> None

      Perform a compatibility check with the target.

      This function should return ``None`` if the plugin is compatible with the current target (``self.target``).
      For example, check if a certain file exists. Otherwise it should raise an
      :class:`UnsupportedPluginError`.

      :raises UnsupportedPluginError: If the plugin could not be loaded.



   .. py:method:: lnk(path: str | None = None) -> collections.abc.Iterator[LnkRecord]

      Parse all .lnk files in /ProgramData, /Users, and /Windows or from a specified path in record format.

      Yields a LnkRecord record with the following fields:

      .. code-block:: text

          lnk_path (path): Path of the link (.lnk) file.
          lnk_name (string): Name of the link (.lnk) file.
          lnk_mtime (datetime): Modification time of the link (.lnk) file.
          lnk_atime (datetime): Access time of the link (.lnk) file.
          lnk_ctime (datetime): Creation time of the link (.lnk) file.
          lnk_relativepath (path): Relative path of target file to the link (.lnk) file.
          lnk_workdir (path): Path of the working directory the link (.lnk) file will execute from.
          lnk_iconlocation (path): Path of the display icon used for the link (.lnk) file.
          lnk_arguments (string): Command-line arguments passed to the target (linked) file.
          local_base_path (string): Absolute path of the target (linked) file.
          common_path_suffix (string): Suffix of the local_base_path.
          lnk_full_path (string): Full path of the linked file. Made from local_base_path and common_path_suffix.
          lnk_net_name (string): Specifies a server share path; for example, "\\server\share".
          lnk_device_name (string): Specifies a device; for example, the drive letter "D:"
          machine_id (string): The NetBIOS name of the machine where the linked file was last known to reside.
          target_mtime (datetime): Modification time of the target (linked) file.
          target_atime (datetime): Access time of the target (linked) file.
          target_ctime (datetime): Creation time of the target (linked) file.



   .. py:method:: lnk_entries(path: str | None = None) -> collections.abc.Iterator[dissect.target.helpers.fsutil.TargetPath]