GitHub Download Forum

UStorage::InsertNamedLink

Inserts a named link to the domain. It allows users to use a well-known ID (name) to retrieve an object. This ID can be the same on multiple domains, while the ObjectIds are generated by the database internally and are unique in every installation.

Syntax

HRESULT InsertNamedLink(
	[in]	const stcObjectLink*	p_polObjectLink,
	[in]	const GUID*	p_pguidName,
	[in]	const wchar_t*	p_strName,
	[in]	HANDLE	p_hActionGroup
);

HRESULT InsertNamedLink(
	[in]	const ObjectId*	p_poiObjectId,
	[in]	const UINT32*	p_aulClassId,
	[in]	UINT32	p_ulClassCount,
	[in]	const GUID*	p_pguidName,
	[in]	const wchar_t*	p_strName,
	[in]	HANDLE	p_hActionGroup
);

Parameter

p_polObjectLink [in]

Type: const stcObjectLink*

ObjectLink to the object to insert as a named link.

p_poiObjectId [in]

Type: const ObjectId*

ObjectId of the ObjectLink to insert as a named link.

p_aulClassId [in]

Type: const UINT32*

Class list of the ObjectLink to insert as a named link.

p_ulClassCount [in]

Type: UINT32

Number of elements in the p_aulClassId array.

p_pguidName [in]

Type: const GUID*

ID (name) of the new named link.

p_strName [in]

Type: const wchar_t*

Description or friendly name of the new named link. This name is used in a GUI or for interaction with users. It cannot be used for retrieving the named link.

p_hActionGroup [in]

Type: HANDLE

ActionGroup to use.

Return value

S_OK or an error from the Error Codes.