nf-oledlg-oleuieditlinksw.md

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:oledlg.OleUIEditLinksW	OleUIEditLinksW function (oledlg.h)	Invokes the standard Links dialog box, allowing the user to make modifications to a container's linked objects. (Unicode)	OleUIEditLinks OleUIEditLinks function [COM] OleUIEditLinksW _ole_OleUIEditLinks com.oleuieditlinks oledlg/OleUIEditLinks oledlg/OleUIEditLinksW	com\oleuieditlinks.htm	com	17c7daf8-83bf-4cfd-a67c-a638630ca263	12/05/2018	OleUIEditLinks, OleUIEditLinks function [COM], OleUIEditLinksA, OleUIEditLinksW, _ole_OleUIEditLinks, com.oleuieditlinks, oledlg/OleUIEditLinks, oledlg/OleUIEditLinksA, oledlg/OleUIEditLinksW	oledlg.h		Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]				OleUIEditLinksW (Unicode) and OleUIEditLinksA (ANSI)						OleDlg.lib	OleDlg.dll		Windows			19H1	OleUIEditLinksW oledlg/OleUIEditLinksW	c++	APIRef kbSyntax	DllExport	OleDlg.dll	OleUIEditLinks OleUIEditLinksA OleUIEditLinksW

OleUIEditLinksW function

-description

Invokes the standard Links dialog box, allowing the user to make modifications to a container's linked objects.

-parameters

-param unnamedParam1 [in]

Pointer to an OLEUIEDITLINKS structure that contains information used to initialize the dialog box.

-returns

Standard Success/Error Definitions

Return code	Description
OLEUI_FALSE	Unknown failure (unused).
OLEUI_OK	The user pressed the OK button.
OLEUI_SUCCESS	No error, same as OLEUI_OK.
OLEUI_CANCEL	The user pressed the Cancel button.

 

Standard Field Validation Errors

Return code	Description
OLEUI_ERR_STANDARDMIN	Errors common to all dialog boxes lie in the range OLEUI_ERR_STANDARDMIN to OLEUI_ERR_STANDARDMAX. This value allows the application to test for standard messages in order to display error messages to the user.
OLEUI_ERR_STRUCTURENULL	The pointer to an OLEUIXXX structure passed into the function was NULL.
OLEUI_ERR_STRUCTUREINVALID	Insufficient permissions for read or write access to an OLEUIXXX structure.
OLEUI_ERR_CBSTRUCTINCORRECT	The cbstruct value is incorrect.
OLEUI_ERR_HWNDOWNERINVALID	The hWndOwner value is invalid.
OLEUI_ERR_LPSZCAPTIONINVALID	The lpszCaption value is invalid.
OLEUI_ERR_LPFNHOOKINVALID	The lpfnHook value is invalid.
OLEUI_ERR_HINSTANCEINVALID	The hInstance value is invalid.
OLEUI_ERR_LPSZTEMPLATEINVALID	The lpszTemplate value is invalid.
OLEUI_ERR_HRESOURCEINVALID	The hResource value is invalid.

 

Initialization Errors

Return code	Description
OLEUI_ERR_FINDTEMPLATEFAILURE	Unable to find the dialog box template.
OLEUI_ERR_LOADTEMPLATEFAILURE	Unable to load the dialog box template.
OLEUI_ERR_DIALOGFAILURE	Dialog box initialization failed.
OLEUI_ERR_LOCALMEMALLOC	A call to LocalAlloc or the standard IMalloc allocator failed.
OLEUI_ERR_GLOBALMEMALLOC	A call to GlobalAlloc or the standard IMalloc allocator failed.
OLEUI_ERR_LOADSTRING	Unable to call LoadString for localized resources from the library.
OLEUI_ERR_OLEMEMALLOC	A call to the standard IMalloc allocator failed.

 

Function Specific Errors

Return code	Description
OLEUI_ERR_STANDARDMAX	Errors common to all dialog boxes lie in the range OLEUI_ERR_STANDARDMIN to OLEUI_ERR_STANDARDMAX. This value allows the application to test for standard messages in order to display error messages to the user.

-remarks

Note

The oledlg.h header defines OLEUIEDITLINKS as an alias which 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 not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.