Edit

Share via

OleCreateFromFile function (ole.h)

  • Article

Creates an embedded object from the contents of a named file.

Syntax

OLESTATUS OleCreateFromFile(
  LPCSTR        unnamedParam1,
  LPOLECLIENT   unnamedParam2,
  LPCSTR        unnamedParam3,
  LPCSTR        unnamedParam4,
  LHCLIENTDOC   unnamedParam5,
  LPCSTR        unnamedParam6,
  LPOLEOBJECT   *unnamedParam7,
  OLEOPT_RENDER unnamedParam8,
  OLECLIPFORMAT unnamedParam9
);

Parameters

unnamedParam1

TBD

unnamedParam2

TBD

unnamedParam3

TBD

unnamedParam4

TBD

unnamedParam5

TBD

unnamedParam6

TBD

unnamedParam7

TBD

unnamedParam8

TBD

unnamedParam9

TBD

Return value

This function returns S_OK on success. Other possible values include the following.

Return code Description
STG_E_FILENOTFOUND
File not bound.
OLE_E_CANT_BINDTOSOURCE
 Not able to bind to source.
STG_E_MEDIUMFULL
 The medium is full.
DV_E_TYMED
 Invalid TYMED.
DV_E_LINDEX
 Invalid LINDEX.
DV_E_FORMATETC
 Invalid FORMATETC structure.

Remarks

The OleCreateFromFile function creates a new embedded object from the contents of a named file. If the ProgID in the registration database contains the PackageOnFileDrop key, it creates a package. If not, the function calls the GetClassFile function to get the CLSID associated with the lpszFileName parameter, and then creates an OLE 2-embedded object associated with that CLSID. The rclsid parameter of OleCreateFromFile will always be ignored, and should be set to CLSID_NULL.

As for other OleCreateXxx functions, the newly created object is not shown to the user for editing, which requires a DoVerb operation. It is used to implement insert file operations.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ole.h (include Ole2.h)
Library Ole32.lib
DLL Ole32.dll

See also

GetClassFile