OleCreateFromFile function

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

Syntax

OLESTATUS OleCreateFromFile(
  LPCSTR        ,
  LPOLECLIENT   ,
  LPCSTR        ,
  LPCSTR        ,
  LHCLIENTDOC   ,
  LPCSTR        ,
  LPOLEOBJECT   *,
  OLEOPT_RENDER ,
  OLECLIPFORMAT 
);

Parameters

arg1

TBD

arg2

TBD

arg3

TBD

arg4

TBD

arg5

TBD

arg6

TBD

arg7

TBD

arg8

TBD

arg9

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

   
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