: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




Attributes
~~~~~~~~~~

.. autoapisummary::

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


.. py:data:: LnkRecord

   

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


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

   Base class for plugins.

   Plugins can optionally be namespaced by specifying the ``__namespace__``
   class attribute. Namespacing results in your plugin needing to be prefixed
   with this namespace when being called. For example, if your plugin has
   specified ``test`` as namespace and a function called ``example``, you must
   call your plugin with ``test.example``::

   A ``Plugin`` class has the following private class attributes:

   - ``__namespace__``
   - ``__record_descriptors__``

   With the following three being assigned in :func:`register`:

   - ``__plugin__``
   - ``__functions__``
   - ``__exports__``

   Additionally, the methods and attributes of :class:`Plugin` receive more private attributes
   by using decorators.

   The :func:`export` decorator adds the following private attributes

   - ``__exported__``
   - ``__output__``: Set with the :func:`export` decorator.
   - ``__record__``: Set with the :func:`export` decorator.

   The :func:`internal` decorator and :class:`InternalPlugin` set the ``__internal__`` attribute.
   Finally. :func:`args` decorator sets the ``__args__`` attribute.

   :param target: The :class:`~dissect.target.target.Target` object to load the plugin for.

   .. 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 ``UnsupportedPluginError``.

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


   .. py:method:: lnk(directory: Optional[str] = None) -> 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:
          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: Optional[str] = None) -> Iterator[dissect.target.helpers.fsutil.TargetPath]