Skip to content

Latest commit

 

History

History
226 lines (177 loc) · 6.03 KB

nf-winbase-createsymboliclinktransacteda.md

File metadata and controls

226 lines (177 loc) · 6.03 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winbase.CreateSymbolicLinkTransactedA
CreateSymbolicLinkTransactedA function (winbase.h)
Creates a symbolic link as a transacted operation. (ANSI)
CreateSymbolicLinkTransactedA
SYMBOLIC_LINK_FLAG_DIRECTORY
winbase/CreateSymbolicLinkTransactedA
fs\createsymboliclinktransacted.htm
fs
e440b940-129b-4638-a0b5-8f516687c74e
12/05/2018
CreateSymbolicLinkTransacted, CreateSymbolicLinkTransacted function [Files], CreateSymbolicLinkTransactedA, CreateSymbolicLinkTransactedW, SYMBOLIC_LINK_FLAG_DIRECTORY, fs.createsymboliclinktransacted, winbase/CreateSymbolicLinkTransacted, winbase/CreateSymbolicLinkTransactedA, winbase/CreateSymbolicLinkTransactedW
winbase.h
Windows.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
CreateSymbolicLinkTransactedW (Unicode) and CreateSymbolicLinkTransactedA (ANSI)
Kernel32.lib
Kernel32.dll
Windows
19H1
CreateSymbolicLinkTransactedA
winbase/CreateSymbolicLinkTransactedA
c++
APIRef
kbSyntax
DllExport
Kernel32.dll
API-MS-Win-Core-Kernel32-Legacy-L1-1-3.dll
Kernel32Legacy.dll
API-MS-Win-Core-Kernel32-Legacy-L1-1-4.dll
API-MS-Win-Core-Kernel32-Legacy-L1-1-5.dll
CreateSymbolicLinkTransacted
CreateSymbolicLinkTransactedA
CreateSymbolicLinkTransactedW

CreateSymbolicLinkTransactedA function

-description

[Microsoft strongly recommends developers utilize alternative means to achieve your application’s needs. Many scenarios that TxF was developed for can be achieved through simpler and more readily available techniques. Furthermore, TxF may not be available in future versions of Microsoft Windows. For more information, and alternatives to TxF, please see Alternatives to using Transactional NTFS.]

Creates a symbolic link as a transacted operation.

-parameters

-param lpSymlinkFileName [in]

The symbolic link to be created.

-param lpTargetFileName [in]

The name of the target for the symbolic link to be created.

If lpTargetFileName has a device name associated with it, the link is treated as an absolute link; otherwise, the link is treated as a relative link.

-param dwFlags [in]

Indicates whether the link target, lpTargetFileName, is a directory.

Value Meaning
0x0
The link target is a file.
SYMBOLIC_LINK_FLAG_DIRECTORY
0x1
The link target is a directory.

-param hTransaction [in]

A handle to the transaction. This handle is returned by the CreateTransaction function.

-returns

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

-remarks

Symbolic links can either be absolute or relative links. Absolute links are links that specify each portion of the path name; relative links are determined relative to where relative–link specifiers are in a specified path. Relative links are specified using the following conventions:

  • Dot (. and ..) conventions—for example, "..\" resolves the path relative to the parent directory.
  • Names with no slashes (\\)—for example, "tmp" resolves the path relative to the current directory.
  • Root relative—for example, "\Windows\System32" resolves to "current drive:\Windows\System32".
  • Current working directory–relative—for example, if the current working directory is C:\Windows\System32, "C:File.txt" resolves to "C:\Windows\System32\File.txt".
    Note  If you specify a current working directory–relative link, it is created as an absolute link, due to the way the current working directory is processed based on the user and the thread.
     
In Windows 8 and Windows Server 2012, this function is supported by the following technologies.
Technology Supported
Server Message Block (SMB) 3.0 protocol No
SMB 3.0 Transparent Failover (TFO) No
SMB 3.0 with Scale-out File Shares (SO) No
Cluster Shared Volume File System (CsvFS) No
Resilient File System (ReFS) No
 

SMB 3.0 does not support TxF.

Note

The winbase.h header defines CreateSymbolicLinkTransacted as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

-see-also

File Management Functions

Symbolic Links

Transactional NTFS