Edit

IMetaDataDispenser::OpenScopeOnMemory method (rometadataapi.h)

  • Article

Opens an area of memory that contains existing metadata. That is, this method opens a specified area of memory in which the existing data is treated as metadata.

Syntax

HRESULT OpenScopeOnMemory(
  [in]  const BYTE *pData,
  [in]  ULONG      cbData,
  [in]  DWORD      dwOpenFlags,
  [in]  REFIID     riid,
  [out] IUnknown   **ppIUnk
);

Parameters

[in] pData

A pointer that specifies the starting address of the memory area.

[in] cbData

The size of the memory area, in bytes.

[in] dwOpenFlags

A value of the CorOpenFlags enumeration to specify the mode (read, write, and so on) for opening.

[in] riid

The IID of the desired metadata interface to be returned; the caller will use the interface to import (read) or emit (write) metadata.

The value of riid must specify one of the "import" or "emit" interfaces. Valid values are IID_IMetaDataEmit, IID_IMetaDataImport, IID_IMetaDataAssemblyEmit, IID_IMetaDataAssemblyImport, IID_IMetaDataEmit2, or IID_IMetaDataImport2.

[out] ppIUnk

The pointer to the returned interface.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The in-memory copy of the metadata can be queried using methods from one of the "import" interfaces, or added to using methods from the one of the "emit" interfaces.

The OpenScopeOnMemory method is similar to the OpenScope method, except that the metadata of interest already exists in memory, rather than in a file on disk.

If the target area of memory does not contain common language runtime (CLR) metadata, the OpenScopeOnMemory method will fail.

Requirements

Requirement Value
Target Platform Windows
Header rometadataapi.h

See also

IMetaDataDispenser