ShellDataObjectFormatSetHGlobalFormat Method (Object, Int32, IntPtr, Int32, DVASPECT, Boolean)

Sets a format to an IDataObject using a HGLOBAL object.

Namespace: ShellBoost.Core
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0

Syntax

Copy

public static int SetHGlobalFormat(
	Object dataObject,
	int format,
	IntPtr hGlobal,
	int index = -1,
	DVASPECT aspect = DVASPECT.DVASPECT_CONTENT,
	bool throwOnError = true
)

Parameters

dataObject: Type: SystemObject
The data object.
format: Type: SystemInt32
The format.
hGlobal: Type: SystemIntPtr
The data. It must be an HGLOBAL handle.
index (Optional): Type: SystemInt32
The FORMATETC index.
aspect (Optional): Type: System.Runtime.InteropServices.ComTypesDVASPECT
The aspect.
throwOnError (Optional): Type: SystemBoolean
if set to true errors may be throw in case of Windows Shell errors.

Return Value

Type: Int32
0 or an error code.

Exceptions

Exception	Condition
ArgumentNullException	dataObject is null.

Reference

ShellDataObjectFormat Class

SetHGlobalFormat Overload

ShellBoost.Core Namespace

ShellBoost Core Documentation

ShellDataObjectFormatAddLanguageSpecificTextSet("LSTA3FD5420_0?cpp=::|nu=.");SetHGlobalFormat Method (Object, Int32, IntPtr, Int32, DVASPECT, Boolean)

Parameters

Return Value

Reference

ShellDataObjectFormatSetHGlobalFormat Method (Object, Int32, IntPtr, Int32, DVASPECT, Boolean)