diff --git a/.openpublishing.redirection.framework.json b/.openpublishing.redirection.framework.json index 86c062d8841ec..20f7232d050d0 100644 --- a/.openpublishing.redirection.framework.json +++ b/.openpublishing.redirection.framework.json @@ -2357,6 +2357,1425 @@ "redirect_url": "/dotnet/core/unmanaged-api/debugging/unregisterforruntimestartup-function", "redirect_document_id": true }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/assemblyflags-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/assemblyflags-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/assemblymetadata-structure.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/assemblymetadata-structure", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/assemblyrefflags-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/assemblyrefflags-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/ceesectionattr-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/ceesectionattr-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/ceesectionrelocextra-union.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/ceesectionrelocextra-union", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/ceesectionreloctype-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/ceesectionreloctype-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/coiniticor-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/coiniticor-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/coinitiee-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/coinitiee-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cor-field-offset-structure.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cor-field-offset-structure", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cor-native-link-structure.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cor-native-link-structure", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corargtype-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corargtype-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corassemblyflags-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corassemblyflags-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corattributetargets-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corattributetargets-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corcallingconvention-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corcallingconvention-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cordeclsecurity-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cordeclsecurity-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corelementtype-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corelementtype-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/coreventattr-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/coreventattr-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corfieldattr-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corfieldattr-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corfileflags-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corfileflags-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corfilemapping-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corfilemapping-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corgenericparamattr-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corgenericparamattr-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corimportoptions-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corimportoptions-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corlinkeroptions-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corlinkeroptions-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cormethodattr-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cormethodattr-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cormethodimpl-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cormethodimpl-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cornativelinkflags-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cornativelinkflags-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cornativelinktype-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cornativelinktype-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cornativetype-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cornativetype-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/coropenflags-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/coropenflags-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corparamattr-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corparamattr-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corpekind-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corpekind-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corpinvokemap-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corpinvokemap-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corpropertyattr-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corpropertyattr-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/correftodefcheck-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/correftodefcheck-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corregflags-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corregflags-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corsavesize-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corsavesize-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corserializationtype-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corserializationtype-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corsetenc-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corsetenc-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cortokentype-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cortokentype-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cortypeattr-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cortypeattr-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/couninitiee-enumeration.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/couninitiee-enumeration", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/cvstruct-structure.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/cvstruct-structure", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-addsectionreloc-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-addsectionreloc-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-computepointer-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-computepointer-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-emitstring-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-emitstring-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-generateceefile-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-generateceefile-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-getilsection-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-getilsection-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-getsectionblock-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-getsectionblock-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-getsectioncreate-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-getsectioncreate-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-getstring-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-getstring-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-getstringsection-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-getstringsection-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/iceegen-truncatesection-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/iceegen-truncatesection-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/ihostfilter-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/ihostfilter-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/ihostfilter-marktoken-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/ihostfilter-marktoken-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imaptoken-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imaptoken-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imaptoken-map-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imaptoken-map-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataassemblyimport-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataconverter-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataconverter-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenser-definescope-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenser-definescope-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenser-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenser-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenser-openscope-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenser-openscope-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenserex-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenserex-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-defineevent-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-defineevent-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definefield-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definefield-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definememberref-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definememberref-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definemethod-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definemethod-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-defineparam-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-defineparam-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-defineproperty-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-defineproperty-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definetypedef-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definetypedef-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-deletetoken-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-deletetoken-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-getsavesize-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-getsavesize-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-merge-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-merge-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-mergeend-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-mergeend-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-save-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-save-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-savetomemory-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-savetomemory-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-savetostream-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-savetostream-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-seteventprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-seteventprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-sethandler-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-sethandler-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setparamprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setparamprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setparent-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setparent-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-setrva-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-setrva-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit2-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit2-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit2-savedelta-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit2-savedelta-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataerror-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataerror-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataerror-onerror-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataerror-onerror-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatafilter-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatafilter-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatafilter-marktoken-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatafilter-marktoken-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-closeenum-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-closeenum-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-countenum-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-countenum-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumevents-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumevents-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumfields-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumfields-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enummembers-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enummembers-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enummethods-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enummethods-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumparams-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumparams-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumproperties-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumproperties-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-findfield-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-findfield-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-findmember-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-findmember-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-findmemberref-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-findmemberref-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-findmethod-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-findmethod-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-findtyperef-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-findtyperef-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-geteventprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-geteventprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getparamprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getparamprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getrva-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getrva-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-getuserstring-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-getuserstring-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-isglobal-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-isglobal-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-resetenum-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-resetenum-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport2-getpekind-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport2-getpekind-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadataimport2-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadataimport2-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatainfo-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatainfo-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getblob-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getblob-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getcolumn-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getcolumn-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getguid-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getguid-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getnextblob-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getnextblob-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getnextguid-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getnextguid-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getnextstring-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getnextstring-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getnumtables-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getnumtables-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getrow-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getrow-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getstring-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getstring-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-gettableindex-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-gettableindex-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getuserstring-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getuserstring-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatatables2-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatatables2-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatavalidate-interface.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatavalidate-interface", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/index.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/index", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/metadata-enumerations.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/metadata-enumerations", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/metadata-global-static-functions.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/" + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/metadata-interfaces.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/metadata-interfaces", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/metadata-structures.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/metadata-structures", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/metadata-unions.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/metadata-unions", + "redirect_document_id": true + }, + { + "source_path_from_root": "/docs/framework/unmanaged-api/metadata/osinfo-structure.md", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/osinfo-structure", + "redirect_document_id": true + }, { "source_path_from_root": "/docs/framework/unmanaged-api/profiling/cor-prf-event-data-structure.md", "redirect_url": "/dotnet/core/unmanaged-api/profiling/cor-prf-event-data-structure", diff --git a/docs/core/unmanaged-api/index.md b/docs/core/unmanaged-api/index.md new file mode 100644 index 0000000000000..bdafadace4228 --- /dev/null +++ b/docs/core/unmanaged-api/index.md @@ -0,0 +1,23 @@ +--- +description: "Learn more about unmanaged APIs for .NET" +title: .NET unmanaged API reference +ms.date: 09/19/2023 +--- +# .NET unmanaged API reference + +This section includes information on unmanaged APIs that can be used by managed-code-related applications, such as runtime hosts, compilers, disassemblers, obfuscators, debuggers, and profilers. + +These articles describe APIs that were introduced in .NET Core 2.0 and later versions, or APIs that can be used with both .NET Framework and .NET. + +For .NET Framework-specific unmanaged APIs, see [.NET Framework unmanaged API reference](../../framework/unmanaged-api/index.md). + +## In this section + +[Debugging](./debugging/index.md)\ +Describes the debugging API, which enables a debugger to debug code that runs in the common language runtime (CLR) environment. + +[Metadata](./metadata/index.md)\ +Describes the metadata API, which enables a client such as a compiler to generate or access a component's metadata without the types being loaded by the CLR. + +[Profiling](./profiling/index.md)\ +Describes the profiling API, which enables a profiler to monitor a program's execution by the CLR. diff --git a/docs/framework/unmanaged-api/metadata/assemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md similarity index 59% rename from docs/framework/unmanaged-api/metadata/assemblyflags-enumeration.md rename to docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md index d953c2830f17d..5a9352d902023 100644 --- a/docs/framework/unmanaged-api/metadata/assemblyflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md @@ -2,60 +2,59 @@ description: "Learn more about: AssemblyFlags Enumeration" title: "AssemblyFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "AssemblyFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AssemblyFlags" -helpviewer_keywords: +helpviewer_keywords: - "AssemblyFlags enumeration [.NET Framework metadata]" -ms.assetid: 40f9bd9e-16ec-447e-81b0-168c875e9866 -topic_type: +topic_type: - "apiref" --- # AssemblyFlags Enumeration -Contains values that describe run-time features of an assembly. - -## Syntax - -```cpp -typedef enum { - afImplicitExportedTypes = 0x0001, - afImplicitResources = 0x0002, - afNonSideBySideAppDomain = 0x0010, - afNonSideBySideProcess = 0x0020, - afNonSideBySideMachine = 0x0030 -} AssemblyFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`afImplicitExportedTypes`|Specifies that exported type definitions are implicit within the files that comprise the assembly. In the .NET Framework versions 1.0 and 1.1, this value is always assumed to be set.| -|`afImplicitResources`|Specifies that resource definitions are implicit within the files that comprise the assembly. In the .NET Framework 1.0 and 1.1, this value is always assumed to be set.| -|`afNonSideBySideAppDomain`|Specifies that the assembly cannot execute with other versions if they are running in the same application domain.| -|`afNonSideBySideProcess`|Specifies that the assembly cannot execute with other versions if they are running in the same process.| -|`afNonSideBySideMachine`|Specifies that the assembly cannot execute with other versions if they are running on the same computer.| - -## Remarks - - The values between 0x0010 and 0x0070, inclusive, are used to describe side-by-side compatibility features of the referenced assembly. If none of these values are set, the assembly is assumed to be side-by-side compatible. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** MsCorEE.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Contains values that describe run-time features of an assembly. + +## Syntax + +```cpp +typedef enum { + afImplicitExportedTypes = 0x0001, + afImplicitResources = 0x0002, + afNonSideBySideAppDomain = 0x0010, + afNonSideBySideProcess = 0x0020, + afNonSideBySideMachine = 0x0030 +} AssemblyFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`afImplicitExportedTypes`|Specifies that exported type definitions are implicit within the files that comprise the assembly. In the .NET Framework versions 1.0 and 1.1, this value is always assumed to be set.| +|`afImplicitResources`|Specifies that resource definitions are implicit within the files that comprise the assembly. In the .NET Framework 1.0 and 1.1, this value is always assumed to be set.| +|`afNonSideBySideAppDomain`|Specifies that the assembly cannot execute with other versions if they are running in the same application domain.| +|`afNonSideBySideProcess`|Specifies that the assembly cannot execute with other versions if they are running in the same process.| +|`afNonSideBySideMachine`|Specifies that the assembly cannot execute with other versions if they are running on the same computer.| + +## Remarks + + The values between 0x0010 and 0x0070, inclusive, are used to describe side-by-side compatibility features of the referenced assembly. If none of these values are set, the assembly is assumed to be side-by-side compatible. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MsCorEE.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/assemblymetadata-structure.md b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md similarity index 55% rename from docs/framework/unmanaged-api/metadata/assemblymetadata-structure.md rename to docs/core/unmanaged-api/metadata/assemblymetadata-structure.md index d43fe5a1edb28..13aeb5b649648 100644 --- a/docs/framework/unmanaged-api/metadata/assemblymetadata-structure.md +++ b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md @@ -2,66 +2,65 @@ description: "Learn more about: ASSEMBLYMETADATA Structure" title: "ASSEMBLYMETADATA Structure" ms.date: "03/30/2017" -api_name: +api_name: - "ASSEMBLYMETADATA" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ASSEMBLYMETADATA" -helpviewer_keywords: +helpviewer_keywords: - "ASSEMBLYMETADATA structure [.NET Framework metadata]" -ms.assetid: 1af98e57-9145-4d35-bb78-77d1da7c91a5 -topic_type: +topic_type: - "apiref" --- # ASSEMBLYMETADATA Structure -Contains information about the referenced assembly, including its version and its level of support for locales, processors, and operating systems. - -## Syntax - -```cpp -typedef struct { - USHORT usMajorVersion; - USHORT usMinorVersion; - USHORT usBuildNumber; - USHORT usRevisionNumber; - LPWSTR szLocale; - ULONG cbLocale; - DWORD* rdwProcessor[]; - ULONG ulProcessor - OSINFO* rOS[]; - ULONG ulOS; -} ASSEMBLYMETADATA; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`usMajorVersion`|The major version number of the referenced assembly. This value cannot be zero. If all the bits of `usMajorVersion` are set, the major version is not specified.| -|`usMinorVersion`|The minor version number of the referenced assembly. This value cannot be zero. If all the bits of `usMinorVersion` are set, the minor version is not specified.| -|`usBuildNumber`|The build number of the referenced assembly. This value cannot be zero. If all the bits of `usBuildNumber` are set, the build number is not specified.| -|`usRevisionNumber`|The revision number of the referenced assembly. This value cannot be zero. If all the bits of `usRevisionNumber` are set, the revision number is not specified.| -|`szLocale`|A list of locale names conforming to the RFC1766 specification, separated by semicolons, specifying the locales supported by the referenced assembly. A null value indicates locale independence. **Note:** In the .NET Framework version 1.0 you cannot specify more than one locale.| -|`cbLocale`|The size in wide characters of `szLocale`.| -|`rdwProcessor`|An array of identifiers, as defined in Winnt.h, for the processor types that are supported by the referenced assembly. A NULL value indicates processor independence.| -|`ulProcessor`|The length of the `rdwProcessor` array.| -|`rOS`|An array of [OSINFO](osinfo-structure.md) instances specifying the operating systems that are supported by the referenced assembly. A NULL value indicates operating-system independence.| -|`ulOS`|The length of the `rOS` array.| - -## Requirements +Contains information about the referenced assembly, including its version and its level of support for locales, processors, and operating systems. + +## Syntax + +```cpp +typedef struct { + USHORT usMajorVersion; + USHORT usMinorVersion; + USHORT usBuildNumber; + USHORT usRevisionNumber; + LPWSTR szLocale; + ULONG cbLocale; + DWORD* rdwProcessor[]; + ULONG ulProcessor + OSINFO* rOS[]; + ULONG ulOS; +} ASSEMBLYMETADATA; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`usMajorVersion`|The major version number of the referenced assembly. This value cannot be zero. If all the bits of `usMajorVersion` are set, the major version is not specified.| +|`usMinorVersion`|The minor version number of the referenced assembly. This value cannot be zero. If all the bits of `usMinorVersion` are set, the minor version is not specified.| +|`usBuildNumber`|The build number of the referenced assembly. This value cannot be zero. If all the bits of `usBuildNumber` are set, the build number is not specified.| +|`usRevisionNumber`|The revision number of the referenced assembly. This value cannot be zero. If all the bits of `usRevisionNumber` are set, the revision number is not specified.| +|`szLocale`|A list of locale names conforming to the RFC1766 specification, separated by semicolons, specifying the locales supported by the referenced assembly. A null value indicates locale independence. **Note:** In the .NET Framework version 1.0 you cannot specify more than one locale.| +|`cbLocale`|The size in wide characters of `szLocale`.| +|`rdwProcessor`|An array of identifiers, as defined in Winnt.h, for the processor types that are supported by the referenced assembly. A NULL value indicates processor independence.| +|`ulProcessor`|The length of the `rdwProcessor` array.| +|`rOS`|An array of [OSINFO](osinfo-structure.md) instances specifying the operating systems that are supported by the referenced assembly. A NULL value indicates operating-system independence.| +|`ulOS`|The length of the `rOS` array.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - ## See also - [Metadata Structures](metadata-structures.md) diff --git a/docs/framework/unmanaged-api/metadata/assemblyrefflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md similarity index 55% rename from docs/framework/unmanaged-api/metadata/assemblyrefflags-enumeration.md rename to docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md index b8db60190c48e..532035683bce5 100644 --- a/docs/framework/unmanaged-api/metadata/assemblyrefflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md @@ -2,46 +2,45 @@ description: "Learn more about: AssemblyRefFlags Enumeration" title: "AssemblyRefFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "AssemblyRefFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AssemblyRefFlags" -helpviewer_keywords: +helpviewer_keywords: - "AssemblyRefFlags enumeration [.NET Framework metadata]" -ms.assetid: decd4f46-f3b2-466f-9501-e74f2b86b846 -topic_type: +topic_type: - "apiref" --- # AssemblyRefFlags Enumeration -Contains values that describe features of an assembly reference. - -## Syntax - -```cpp -typedef enum { - arfFullOriginator = 0x0001 -} AssemblyRefFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`arfFullOriginator`|Specifies that the assembly reference contains full, unhashed information about the publisher of the assembly.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Contains values that describe features of an assembly reference. + +## Syntax + +```cpp +typedef enum { + arfFullOriginator = 0x0001 +} AssemblyRefFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`arfFullOriginator`|Specifies that the assembly reference contains full, unhashed information about the publisher of the assembly.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md new file mode 100644 index 0000000000000..1bf9eafb52013 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md @@ -0,0 +1,56 @@ +--- +description: "Learn more about: CeeSectionAttr Enumeration" +title: "CeeSectionAttr Enumeration" +ms.date: "03/30/2017" +api_name: + - "CeeSectionAttr" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CeeSectionAttr" +helpviewer_keywords: + - "CeeSectionAttr enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CeeSectionAttr Enumeration + +Provides values that specify attributes of a section for use by the [ICeeGen](iceegen-interface.md) interface. + +## Syntax + +```cpp +typedef enum { + sdNone = 0, + sdReadOnly = IMAGE_SCN_CNT_INITIALIZED_DATA | + IMAGE_SCN_MEM_READ, + sdReadWrite = sdReadOnly | IMAGE_SCN_MEM_WRITE, + sdExecute = IMAGE_SCN_MEM_READ | IMAGE_SCN_CNT_CODE | + IMAGE_SCN_MEM_EXECUTE +} CeeSectionAttr; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`sdNone`|Section has no attributes.| +|`sdReadOnly`|Section contains initialized data that can be only read, not updated.| +|`sdReadWrite`|Section contains initialized data that can be read or updated.| +|`sdExecute`|Section contains executable code that is allowed to be read and executed.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md new file mode 100644 index 0000000000000..bbac75150a16e --- /dev/null +++ b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md @@ -0,0 +1,48 @@ +--- +description: "Learn more about: CeeSectionRelocExtra Union" +title: "CeeSectionRelocExtra Union" +ms.date: "03/30/2017" +api_name: + - "CeeSectionRelocExtra Union" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CeeSectionRelocExtra" +helpviewer_keywords: + - "CeeSectionRelocExtra union [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CeeSectionRelocExtra Union + +Represents an address offset that is used by the [ICeeGen](iceegen-interface.md) interface to relocate a section. + +## Syntax + +```cpp +typedef union { + USHORT highAdj; +} CeeSectionRelocExtra; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`highAdj`|The upper address adjustment for the section.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Unions](metadata-unions.md) diff --git a/docs/framework/unmanaged-api/metadata/ceesectionreloctype-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/ceesectionreloctype-enumeration.md rename to docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md index 621d6a789ba1a..0c05b601eecc4 100644 --- a/docs/framework/unmanaged-api/metadata/ceesectionreloctype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md @@ -2,78 +2,77 @@ description: "Learn more about: CeeSectionRelocType Enumeration" title: "CeeSectionRelocType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CeeSectionRelocType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CeeSectionRelocType" -helpviewer_keywords: +helpviewer_keywords: - "CeeSectionRelocType enumeration [.NET Framework metadata]" -ms.assetid: 124656f6-0dad-4ceb-9043-d3869ab65cde -topic_type: +topic_type: - "apiref" --- # CeeSectionRelocType Enumeration -Provides values to influence the type of `reloc` instruction emitted in a call to [ICeeGen::AddSectionReloc](iceegen-addsectionreloc-method.md). - -## Syntax - -```cpp -typedef enum { - srRelocAbsolute, - srRelocHighLow = 3, +Provides values to influence the type of `reloc` instruction emitted in a call to [ICeeGen::AddSectionReloc](iceegen-addsectionreloc-method.md). + +## Syntax + +```cpp +typedef enum { + srRelocAbsolute, + srRelocHighLow = 3, srRelocHighAdj, - srRelocMapToken, - srRelocRelative, - srRelocFilePos, - srRelocCodeRelative, - srRelocIA64Imm64, - srRelocDir64, - srRelocIA64PcRel25, - srRelocIA64PcRel64, srRelocAbsoluteTagged, srRelocSentinel, srNoBaseReloc = 0x4000, - srRelocPtr = 0x8000, - srRelocAbsolutePtr = srRelocPtr + srRelocAbsolute, - srRelocHighLowPtr = srRelocPtr + srRelocHighLow, - srRelocRelativePtr = srRelocPtr + srRelocRelative, - srRelocIA64Imm64Ptr = srRelocPtr + srRelocIA64Imm64, - srRelocDir64Ptr = srRelocPtr + srRelocDir64 - } CeeSectionRelocType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`srRelocAbsolute`|Generates only a section-relative `reloc`, sending nothing into a .reloc section.| -|`srRelocHighLow`|Generates a `reloc` for a pointer-sized location. This is transformed into BASED_HIGHLOW or BASED_DIR64 depending on the platform.| -|`srRelocHighAdj`|Generates a `reloc` for the top 16 bits of a 32-bit number, where the bottom 16 bits are included in the next word in the .reloc table.| -|`srRelocMapToken`|Generates a token map relocation, sending nothing into a .reloc section.| -|`srRelocRelative`|Indicates that the value is a relative address fixup.| -|`srRelocFilePos`|Generates only a section-relative `reloc`, sending nothing into a .reloc section. This `reloc` is relative to the file position of the section, not the section's virtual address.| -|`srRelocCodeRelative`|Specifies a code-relative address fixup.| -|`srRelocIA64Imm64`|Generates a `reloc` for a 64 bit address in an ia64 `movl` instruction.| -|`srRelocDir64`|Generates a `reloc` for a 64-bit address.| -|`srRelocIA64PcRel25`|Generate a `reloc` for a 25-bit PC-relative address in an ia64 `br.call` instruction.| -|`srRelocIA64PcRel64`|Generates a `reloc` for a 64-bit PC-relative address in an ia64 `brl.call` instruction.| -|`srRelocAbsoluteTagged`|Generates a 30-bit section-relative `reloc`, used for tagged pointer values.| -|`srRelocSentinel`|A sentinel value to help ensure any additions to this enum are reflected to the internal `reloc` name array.| -|`srNoBaseReloc`|Specifies not to emit a base `reloc`.| -|`srRelocPtr`|A value indicating that the pre-fixup contents of memory are a pointer rather than a section offset.| - -## Requirements + srRelocMapToken, + srRelocRelative, + srRelocFilePos, + srRelocCodeRelative, + srRelocIA64Imm64, + srRelocDir64, + srRelocIA64PcRel25, + srRelocIA64PcRel64, srRelocAbsoluteTagged, srRelocSentinel, srNoBaseReloc = 0x4000, + srRelocPtr = 0x8000, + srRelocAbsolutePtr = srRelocPtr + srRelocAbsolute, + srRelocHighLowPtr = srRelocPtr + srRelocHighLow, + srRelocRelativePtr = srRelocPtr + srRelocRelative, + srRelocIA64Imm64Ptr = srRelocPtr + srRelocIA64Imm64, + srRelocDir64Ptr = srRelocPtr + srRelocDir64 + } CeeSectionRelocType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`srRelocAbsolute`|Generates only a section-relative `reloc`, sending nothing into a .reloc section.| +|`srRelocHighLow`|Generates a `reloc` for a pointer-sized location. This is transformed into BASED_HIGHLOW or BASED_DIR64 depending on the platform.| +|`srRelocHighAdj`|Generates a `reloc` for the top 16 bits of a 32-bit number, where the bottom 16 bits are included in the next word in the .reloc table.| +|`srRelocMapToken`|Generates a token map relocation, sending nothing into a .reloc section.| +|`srRelocRelative`|Indicates that the value is a relative address fixup.| +|`srRelocFilePos`|Generates only a section-relative `reloc`, sending nothing into a .reloc section. This `reloc` is relative to the file position of the section, not the section's virtual address.| +|`srRelocCodeRelative`|Specifies a code-relative address fixup.| +|`srRelocIA64Imm64`|Generates a `reloc` for a 64 bit address in an ia64 `movl` instruction.| +|`srRelocDir64`|Generates a `reloc` for a 64-bit address.| +|`srRelocIA64PcRel25`|Generate a `reloc` for a 25-bit PC-relative address in an ia64 `br.call` instruction.| +|`srRelocIA64PcRel64`|Generates a `reloc` for a 64-bit PC-relative address in an ia64 `brl.call` instruction.| +|`srRelocAbsoluteTagged`|Generates a 30-bit section-relative `reloc`, used for tagged pointer values.| +|`srRelocSentinel`|A sentinel value to help ensure any additions to this enum are reflected to the internal `reloc` name array.| +|`srNoBaseReloc`|Specifies not to emit a base `reloc`.| +|`srRelocPtr`|A value indicating that the pre-fixup contents of memory are a pointer rather than a section offset.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - ## See also - [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md new file mode 100644 index 0000000000000..21c9136bf63cd --- /dev/null +++ b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: COINITICOR Enumeration" +title: "COINITICOR Enumeration" +ms.date: "03/30/2017" +api_name: + - "COINITICOR" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "COINITICOR" +helpviewer_keywords: + - "COINITICOR enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# COINITICOR Enumeration + +Specifies constants used by [CoInitializeCor](../../../framework/unmanaged-api/hosting/coinitializecor-function.md) when it initializes the common language runtime. + +## Syntax + +```cpp +typedef enum tagCOINITCOR +{ + COINITCOR = 0x0 +} COINITICOR; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`COINITCOR`|Indicates the default initialization mode.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md new file mode 100644 index 0000000000000..e5fd3156a3a73 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md @@ -0,0 +1,52 @@ +--- +description: "Learn more about: COINITIEE Enumeration" +title: "COINITIEE Enumeration" +ms.date: "03/30/2017" +api_name: + - "COINITIEE" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "COINITIEE" +helpviewer_keywords: + - "COINITIEE enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# COINITIEE Enumeration + +Specifies constants used by [CoInitializeEE](../../../framework/unmanaged-api/hosting/coinitializeee-function.md) when initializing the common language runtime. + +## Syntax + +```cpp +typedef enum tagCOINITEE { + COINITEE_DEFAULT = 0x0, + COINITEE_DLL = 0x1, + COINITEE_MAIN = 0x2 +} COINITIEE; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`COINITEE_DEFAULT`|Default initialization mode. This initializes the runtime and creates the default .| +|`COINITEE_DLL`|Initializes to run a managed DLL.| +|`COINITEE_MAIN`|Initializes to run a managed EXE. This initializes the runtime but does not create the default , which is created after entering the main routine of the EXE.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md new file mode 100644 index 0000000000000..607d5417f130d --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md @@ -0,0 +1,54 @@ +--- +description: "Learn more about: COR_FIELD_OFFSET Structure" +title: "COR_FIELD_OFFSET Structure" +ms.date: "03/30/2017" +api_name: + - "COR_FIELD_OFFSET" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "COR_FIELD_OFFSET" +helpviewer_keywords: + - "COR_FIELD_OFFSET structure [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# COR_FIELD_OFFSET Structure + +Stores the offset, within a class, of the specified field. + +## Syntax + +```cpp +typedef struct COR_FIELD_OFFSET { + mdFieldDef ridOfField; + ULONG ulOffset; +} COR_FIELD_OFFSET; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`ridOfField`|An `mdFieldDef` metadata token that represents the field.| +|`ulOffset`|The field's offset within its class.| + +## Remarks + + [IMetaDataImport::GetClassLayout](imetadataimport-getclasslayout-method.md) and [IMetaDataEmit::SetClassLayout](imetadataemit-setclasslayout-method.md) methods take a parameter of type `COR_FIELD_OFFSET`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h, CorProf.idl + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Structures](metadata-structures.md) +- [IMetaDataEmit Interface](imetadataemit-interface.md) +- [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/cor-native-link-structure.md b/docs/core/unmanaged-api/metadata/cor-native-link-structure.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/cor-native-link-structure.md rename to docs/core/unmanaged-api/metadata/cor-native-link-structure.md index 46bcd987eac92..51d30be6786d6 100644 --- a/docs/framework/unmanaged-api/metadata/cor-native-link-structure.md +++ b/docs/core/unmanaged-api/metadata/cor-native-link-structure.md @@ -2,53 +2,52 @@ description: "Learn more about: COR_NATIVE_LINK Structure" title: "COR_NATIVE_LINK Structure" ms.date: "03/30/2017" -api_name: +api_name: - "COR_NATIVE_LINK" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COR_NATIVE_LINK" -helpviewer_keywords: +helpviewer_keywords: - "COR_NATIVE_LINK structure [.NET Framework metadata]" -ms.assetid: 6ef78d3c-1c69-4141-b687-dcb065b7a74d -topic_type: +topic_type: - "apiref" --- # COR_NATIVE_LINK Structure -Contains information that is used to link native code. - -## Syntax - -```cpp +Contains information that is used to link native code. + +## Syntax + +```cpp typedef struct -{ - BYTE m_linkType; - BYTE m_flags; - mdMemberRef m_entryPoint; -} COR_NATIVE_LINK; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`m_linkType`|The type to be linked in native code. This value is one of the [CorNativeLinkType](cornativelinktype-enumeration.md) values.| -|`m_flags`|Flags used by the linker when linking native code. This value is one of the [CorNativeLinkFlags](cornativelinkflags-enumeration.md) values.| -|`m_entryPoint`|The MemberRef metadata token that represents the entry point. The format is `lib:entrypoint`.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +{ + BYTE m_linkType; + BYTE m_flags; + mdMemberRef m_entryPoint; +} COR_NATIVE_LINK; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`m_linkType`|The type to be linked in native code. This value is one of the [CorNativeLinkType](cornativelinktype-enumeration.md) values.| +|`m_flags`|Flags used by the linker when linking native code. This value is one of the [CorNativeLinkFlags](cornativelinkflags-enumeration.md) values.| +|`m_entryPoint`|The MemberRef metadata token that represents the entry point. The format is `lib:entrypoint`.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Structures](metadata-structures.md) diff --git a/docs/core/unmanaged-api/metadata/corargtype-enumeration.md b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md new file mode 100644 index 0000000000000..0ec25e5030d73 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md @@ -0,0 +1,52 @@ +--- +description: "Learn more about: CorArgType Enumeration" +title: "CorArgType Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorArgType" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorArgType" +helpviewer_keywords: + - "CorArgType enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorArgType Enumeration + +Contains values that describe the native type of a runtime handle. + +## Syntax + +```cpp +typedef enum CorArgType { + + IMAGE_CEE_CS_END = 0x0, + IMAGE_CEE_CS_VOID = 0x1, + IMAGE_CEE_CS_I4 = 0x2, + IMAGE_CEE_CS_I8 = 0x3, + IMAGE_CEE_CS_R4 = 0x4, + IMAGE_CEE_CS_R8 = 0x5, + IMAGE_CEE_CS_PTR = 0x6, + IMAGE_CEE_CS_OBJECT = 0x7, + IMAGE_CEE_CS_STRUCT4 = 0x8, + IMAGE_CEE_CS_STRUCT32 = 0x9, + IMAGE_CEE_CS_BYVALUE = 0xA + +} CorArgType; +``` + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md new file mode 100644 index 0000000000000..c3d558e6343aa --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md @@ -0,0 +1,84 @@ +--- +description: "Learn more about: CorAssemblyFlags Enumeration" +title: "CorAssemblyFlags Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorAssemblyFlags" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorAssemblyFlags" +helpviewer_keywords: + - "CorAssemblyFlags enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorAssemblyFlags Enumeration + +Contains values that describe the metadata applied to an assembly compilation. + +## Syntax + +```cpp +typedef enum CorAssemblyFlags { + + afPublicKey = 0x0001, + afPA_None = 0x0000, + afPA_MSIL = 0x0010, + afPA_x86 = 0x0020, + afPA_IA64 = 0x0030, + afPA_AMD64 = 0x0040, + afPA_ARM = 0x0050, + afPA_NoPlatform = 0x0070, + afPA_Specified = 0x0080, + afPA_Mask = 0x0070, + afPA_FullMask = 0x00F0, + afPA_Shift = 0x0004, + + afEnableJITcompileTracking = 0x8000, + afDisableJITcompileOptimizer= 0x4000, + + afRetargetable = 0x0100, + afContentType_Default = 0x0000, + afContentType_WindowsRuntime = 0x0200, + afContentType_Mask = 0x0E00, + +} CorAssemblyFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`afPublicKey`|Indicates that the assembly reference holds the full, unhashed public key.| +|`afPA_None`|Indicates that the processor architecture is unspecified.| +|`afPA_MSIL`|Indicates that the processor architecture is neutral (PE32).| +|`afPA_x86`|Indicates that the processor architecture is x86 (PE32).| +|`afPA_IA64`|Indicates that the processor architecture is Itanium (PE32+).| +|`afPA_AMD64`|Indicates that the processor architecture is AMD X64 (PE32+).| +|`afPA_ARM`|Indicates that the processor architecture is ARM (PE32).| +|`afPA_NoPlatform`|Indicates that the assembly is a reference assembly; that is, it applies to any architecture but cannot run on any architecture. Thus, the flag is the same as `afPA_Mask`.| +|`afPA_Specified`|Indicates that the processor architecture flags should be propagated to the `AssemblyRef` record.| +|`afPA_Mask`|A mask that describes the processor architecture.| +|`afPA_FullMask`|Specifies that the processor architecture description is included.| +|`afPA_Shift`|Indicates a shift count in the processor architecture flags to and from the index.| +|`afEnableJITcompileTracking`|Indicates the corresponding value from the of the .| +|`afDisableJITcompileOptimizer`|Indicates the corresponding value from the of the .| +|`afRetargetable`|Indicates that the assembly can be retargeted at run time to an assembly from a different publisher.| +|`afContentType_Mask`|A mask that describes the content type.| +|`afContentType_Default`|Indicates the default content type.| +|`afContentType_WindowsRuntime`|Indicates the Windows Runtime content type.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md new file mode 100644 index 0000000000000..ac5267baf8188 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md @@ -0,0 +1,93 @@ +--- +description: "Learn more about: CorAttributeTargets Enumeration" +title: "CorAttributeTargets Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorAttributeTargets" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorAttributeTargets" +helpviewer_keywords: + - "CorAttributeTargets enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorAttributeTargets Enumeration + +Specifies the application elements on which it is valid to apply an attribute. + +## Syntax + +```cpp +typedef enum CorAttributeTargets +{ + catAssembly = 0x0001, + catModule = 0x0002, + catClass = 0x0004, + catStruct = 0x0008, + catEnum = 0x0010, + catConstructor = 0x0020, + catMethod = 0x0040, + catProperty = 0x0080, + catField = 0x0100, + catEvent = 0x0200, + catInterface = 0x0400, + catParameter = 0x0800, + catDelegate = 0x1000, + catGenericParameter = 0x4000, + + catAll = + catAssembly | catModule | catClass | catStruct | + catEnum | catConstructor | catMethod | catProperty | + catField | catEvent | catInterface | catParameter | + catDelegate | catGenericParameter, + + catClassMembers = + catClass | catStruct | catEnum | catConstructor | + catMethod | catProperty | catField | catEvent | + catDelegate | catInterface + +} CorAttributeTargets; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`catAssembly`|Attribute can be applied to an assembly.| +|`catModule`|Attribute can be applied to a portable executable (.dll or .exe) module.| +|`catClass`|Attribute can be applied to a class.| +|`catStruct`|Attribute can be applied to a structure; that is, a value type.| +|`catEnum`|Attribute can be applied to an enumeration.| +|`catConstructor`|Attribute can be applied to a constructor.| +|`catMethod`|Attribute can be applied to a method.| +|`catProperty`|Attribute can be applied to a property.| +|`catField`|Attribute can be applied to a field.| +|`catEvent`|Attribute can be applied to an event.| +|`catInterface`|Attribute can be applied to an interface.| +|`catParameter`|Attribute can be applied to a parameter.| +|`catDelegate`|Attribute can be applied to a delegate.| +|`catGenericParameter`|Attribute can be applied to a generic parameter.| +|`catAll`|Attribute can be applied to any application element.| +|`catClassMembers`|Attribute can be applied to a member of a class.| + +## Remarks + + The `CorAttributeTargets` enumeration values can be combined with a bitwise OR operation to get the preferred combination. + + The `CorAttributeTargets` parallels the managed enumeration. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md new file mode 100644 index 0000000000000..99633b8a3ecaa --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md @@ -0,0 +1,74 @@ +--- +description: "Learn more about: CorCallingConvention Enumeration" +title: "CorCallingConvention Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorCallingConvention" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorCallingConvention" +helpviewer_keywords: + - "CorCallingConvention enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorCallingConvention Enumeration + +Contains values that describe the types of calling conventions that are made in managed code. + +## Syntax + +```cpp +typedef enum CorCallingConvention +{ + IMAGE_CEE_CS_CALLCONV_DEFAULT = 0x0, + + IMAGE_CEE_CS_CALLCONV_VARARG = 0x5, + IMAGE_CEE_CS_CALLCONV_FIELD = 0x6, + IMAGE_CEE_CS_CALLCONV_LOCAL_SIG = 0x7, + IMAGE_CEE_CS_CALLCONV_PROPERTY = 0x8, + IMAGE_CEE_CS_CALLCONV_UNMGD = 0x9, + IMAGE_CEE_CS_CALLCONV_GENERICINST = 0xa, + IMAGE_CEE_CS_CALLCONV_NATIVEVARARG = 0xb, + IMAGE_CEE_CS_CALLCONV_MAX = 0xc, + + IMAGE_CEE_CS_CALLCONV_MASK = 0x0f, + IMAGE_CEE_CS_CALLCONV_HASTHIS = 0x20, + IMAGE_CEE_CS_CALLCONV_EXPLICITTHIS = 0x40, + IMAGE_CEE_CS_CALLCONV_GENERIC = 0x10 + +} CorCallingConvention; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`IMAGE_CEE_CS_CALLCONV_DEFAULT`|Indicates a default calling convention.| +|`IMAGE_CEE_CS_CALLCONV_VARARG`|Indicates that the method takes a variable number of parameters.| +|`IMAGE_CEE_CS_CALLCONV_FIELD`|Indicates that the call is to a field.| +|`IMAGE_CEE_CS_CALLCONV_LOCAL_SIG`|Indicates that the call is to a local method.| +|`IMAGE_CEE_CS_CALLCONV_PROPERTY`|Indicates that the call is to a property.| +|`IMAGE_CEE_CS_CALLCONV_UNMGD`|Indicates that the call is unmanaged.| +|`IMAGE_CEE_CS_CALLCONV_GENERICINST`|Indicates a generic method instantiation.| +|`IMAGE_CEE_CS_CALLCONV_NATIVEVARARG`|Indicates a 64-bit PInvoke call to a method that takes a variable number of parameters.| +|`IMAGE_CEE_CS_CALLCONV_MAX`|Describes an invalid 4-bit value.| +|`IMAGE_CEE_CS_CALLCONV_MASK`|Indicates that the calling convention is described by the bottom four bits.| +|`IMAGE_CEE_CS_CALLCONV_HASTHIS`|Indicates that the top bit describes a `this` parameter.| +|`IMAGE_CEE_CS_CALLCONV_EXPLICITTHIS`|Indicates that a `this` parameter is explicitly described in the signature.| +|`IMAGE_CEE_CS_CALLCONV_GENERIC`|Indicates a generic method signature with an explicit number of type arguments. This precedes an ordinary parameter count.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md new file mode 100644 index 0000000000000..053eb6e6ed37e --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md @@ -0,0 +1,104 @@ +--- +description: "Learn more about: CorCheckDuplicatesFor Enumeration" +title: "CorCheckDuplicatesFor Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorCheckDuplicatesFor" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorCheckDuplicatesFor" +helpviewer_keywords: + - "CorCheckDuplicatesFor enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorCheckDuplicatesFor Enumeration + +Specifies the metadata tokens that will be checked for duplicates. + +## Syntax + +```cpp +typedef enum CorCheckDuplicatesFor { + + MDDupAll = 0xffffffff, + MDDupENC = MDDupAll, + MDNoDupChecks = 0x00000000, + MDDupTypeDef = 0x00000001, + MDDupInterfaceImpl = 0x00000002, + MDDupMethodDef = 0x00000004, + MDDupTypeRef = 0x00000008, + MDDupMemberRef = 0x00000010, + MDDupCustomAttribute = 0x00000020, + MDDupParamDef = 0x00000040, + MDDupPermission = 0x00000080, + MDDupProperty = 0x00000100, + MDDupEvent = 0x00000200, + MDDupFieldDef = 0x00000400, + MDDupSignature = 0x00000800, + MDDupModuleRef = 0x00001000, + MDDupTypeSpec = 0x00002000, + MDDupImplMap = 0x00004000, + MDDupAssemblyRef = 0x00008000, + MDDupFile = 0x00010000, + MDDupExportedType = 0x00020000, + MDDupManifestResource = 0x00040000, + MDDupGenericParam = 0x00080000, + MDDupMethodSpec = 0x00100000, + MDDupGenericParamConstraint = 0x00200000, + + MDDupAssembly = 0x10000000, + + MDDupDefault = + MDNoDupChecks | MDDupTypeRef | MDDupMemberRef | + MDDupSignature | MDDupTypeSpec | MDDupMethodSpec + +} CorCheckDuplicatesFor; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MDDupAll`|Check all metadata tokens for duplicates.| +|`MDDupENC`|Not used.| +|`MDNoDupChecks`|Do not check metadata tokens for duplicates.| +|`MDDupTypeDef`|Check for duplicates of `mdTypeDef` tokens.| +|`MDDupInterfaceImpl`|Check for duplicates of `mdInterfaceImpl` tokens.| +|`MDDupMethodDef`|Check for duplicates of `mdMethodDef` tokens.| +|`MDDupTypeRef`|Check for duplicates of `mdTypeRef` tokens.| +|`MDDupMemberRef`|Check for duplicates of `mdMemberRef` tokens.| +|`MDDupCustomAttribute`|Check for duplicates of `mdCustomAttribute` tokens.| +|`MDDupParamDef`|Check for duplicates of `mdParamDef` tokens.| +|`MDDupPermission`|Check for duplicates of `mdPermission` tokens.| +|`MDDupProperty`|Check for duplicates of `mdProperty` tokens.| +|`MDDupEvent`|Check for duplicates of `mdEvent` tokens.| +|`MDDupFieldDef`|Check for duplicates of `mdFieldDef` tokens.| +|`MDDupSignature`|Check for duplicates of `mdSignature` tokens.| +|`MDDupModuleRef`|Check for duplicates of `mdModuleRef` tokens.| +|`MDDupTypeSpec`|Check for duplicates of `mdTypeSpec` tokens.| +|`MDDupImplMap`|Check for duplicates of `mdImplMap` tokens.| +|`MDDupAssemblyRef`|Check for duplicates of `mdAssemblyRef` tokens.| +|`MDDupFile`|Check for duplicates of `mdFile` tokens.| +|`MDDupExportedType`|Check for duplicates of `mdExportedType` tokens.| +|`MDDupManifestResource`|Check for duplicates of `mdManifestResource` tokens.| +|`MDDupGenericParam`|Check for duplicates of `mdGenericParam` tokens.| +|`MDDupMethodSpec`|Check for duplicates of `mdMethodSpec` tokens.| +|`MDDupGenericParamConstraint`|Check for duplicates of `mdGenericParamConstraint` tokens.| +|`MDDupAssembly`|Check for duplicates of `mdAssembly` tokens.| +|`MDDupDefault`|Check for duplicates of `mdMemberRef`, `mdTypeRef`, `mdSignature`, `mdTypeSpec`, and `mdMethodSpec` tokens.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md new file mode 100644 index 0000000000000..7fb234cb53d17 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md @@ -0,0 +1,88 @@ +--- +description: "Learn more about: CorDeclSecurity Enumeration" +title: "CorDeclSecurity Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorDeclSecurity" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorDeclSecurity" +helpviewer_keywords: + - "CorDeclSecurity enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorDeclSecurity Enumeration + +Specifies the security actions that can be performed using declarative security. + +## Syntax + +```cpp +typedef enum CorDeclSecurity { + + dclActionMask = 0x001f, + dclActionNil = 0x0000, + dclRequest = 0x0001, + dclDemand = 0x0002, + dclAssert = 0x0003, + dclDeny = 0x0004, + dclPermitOnly = 0x0005, + dclLinktimeCheck = 0x0006, + dclInheritanceCheck = 0x0007, + dclRequestMinimum = 0x0008, + dclRequestOptional = 0x0009, + dclRequestRefuse = 0x000a, + dclPrejitGrant = 0x000b, + dclPrejitDenied = 0x000c, + dclNonCasDemand = 0x000d, + dclNonCasLinkDemand = 0x000e, + dclNonCasInheritance = 0x000f, + dclLinkDemandChoice = 0x0010, + dclInheritanceDemandChoice = 0x0011, + dclDemandChoice = 0x0012, + dclMaximumValue = 0x0012 + +} CorDeclSecurity; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`dclActionMask`|Reserved.| +|`dclActionNil`|Reserved.| +|`dclRequest`|Reserved.| +|`dclDemand`|All callers higher in the call stack are required to have been granted the permission specified by the current permission object.| +|`dclAssert`|The calling code can access the resource identified by the current permission object, even if callers higher in the stack have not been granted permission to access the resource| +|`dclDeny`|The ability to access the resource specified by the current permission object is denied to callers, even if they have been granted permission to access it.| +|`dclPermitOnly`|Only the resources specified by this permission object can be accessed, even if the code has been granted permission to access other resources.| +|`dclLinktimeCheck`|The immediate caller is required to have been granted the specified permission for a given period of time.| +|`dclInheritanceCheck`|The derived class inheriting another class or overriding a method is required to have been granted the specified permission.| +|`dclRequestMinimum`|The caller can request for the minimum permissions required for code to run. This action can only be used within the scope of the assembly.| +|`dclRequestOptional`|The caller can request for additional permissions that are optional (not required to run). This request implicitly refuses all other permissions not specifically requested. This action can only be used within the scope of the assembly.| +|`dclRequestRefuse`|The caller's request for permissions that might be misused will not be granted. This action can only be used within the scope of the assembly.| +|`dclPrejitGrant`|Reserved.| +|`dclPrejitDenied`|Reserved.| +|`dclNonCasDemand`|Reserved.| +|`dclNonCasLinkDemand`|The immediate caller is required to have been granted the specified permission.| +|`dclNonCasInheritance`|Reserved.| +|`dclLinkDemandChoice`|Reserved.| +|`dclInheritanceDemandChoice`|Reserved.| +|`dclDemandChoice`|Reserved.| +|`dclMaximumValue`|Reserved.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corelementtype-enumeration.md b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md similarity index 95% rename from docs/framework/unmanaged-api/metadata/corelementtype-enumeration.md rename to docs/core/unmanaged-api/metadata/corelementtype-enumeration.md index 087b612523873..58b101a02ce31 100644 --- a/docs/framework/unmanaged-api/metadata/corelementtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md @@ -12,7 +12,6 @@ f1_keywords: - "CorElementType" helpviewer_keywords: - "CorElementType enumeration [.NET Framework metadata]" -ms.assetid: c3809c8f-1737-4f0f-9442-0c01ee689871 topic_type: - "apiref" --- @@ -135,11 +134,11 @@ The type modifiers form the basis for representing more complex types. A `CorEle ## Requirements -**Platforms:** See [System Requirements](../../get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h -**.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] +**.NET versions:** Available since .NET Framework 1.0 ## See also diff --git a/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md new file mode 100644 index 0000000000000..2a23419ffeeda --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md @@ -0,0 +1,62 @@ +--- +description: "Learn more about: CorErrorIfEmitOutOfOrder Enumeration" +title: "CorErrorIfEmitOutOfOrder Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorErrorIfEmitOutOfOrder" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorErrorIfEmitOutOfOrder" +helpviewer_keywords: + - "CorErrorIfEmitOutOfOrder enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorErrorIfEmitOutOfOrder Enumeration + +Contains flag values that indicate the conditions under which an error message should be generated when metadata is emitted out of order. + +## Syntax + +```cpp +typedef enum CorErrorIfEmitOutOfOrder { + + MDErrorOutOfOrderDefault = 0x00000000, + MDErrorOutOfOrderNone = 0x00000000, + MDErrorOutOfOrderAll = 0xffffffff, + MDMethodOutOfOrder = 0x00000001, + MDFieldOutOfOrder = 0x00000002, + MDParamOutOfOrder = 0x00000004, + MDPropertyOutOfOrder = 0x00000008, + MDEventOutOfOrder = 0x00000010 + +} CorErrorIfEmitOutOfOrder; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MDErrorOutOfOrderDefault`|Indicates the default behavior, which does not generate error messages.| +|`MDErrorOutOfOrderNone`|Indicates that the compiler should not generate error messages.| +|`MDErrorOutOfOrderAll`|Indicates that the compiler should generate an error message when a field, property, event, method, or parameter is emitted out of order.| +|`MDMethodOutOfOrder`|Indicates that the compiler should generate an error message when a method is emitted out of order.| +|`MDFieldOutOfOrder`|Indicates that the compiler should generate an error message when a field is emitted out of order.| +|`MDParamOutOfOrder`|Indicates that the compiler should generate an error message when a parameter is emitted out of order.| +|`MDPropertyOutOfOrder`|Indicates that the compiler should generate an error message when a property is emitted out of order.| +|`MDEventOutOfOrder`|Indicates that the compiler should generate an error message when an event is emitted out of order.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md new file mode 100644 index 0000000000000..4e76be6e4a406 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: CorEventAttr Enumeration" +title: "CorEventAttr Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorEventAttr" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorEventAttr" +helpviewer_keywords: + - "CorEventAttr enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorEventAttr Enumeration + +Contains values that describe the metadata of an event. + +## Syntax + +```cpp +typedef enum CorEventAttr { + + evSpecialName = 0x0200, + + evReservedMask = 0x0400, + evRTSpecialName = 0x0400, + +} CorEventAttr; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`evSpecialName`|Specifies that the event is special, and that its name describes how.| +|`evReservedMask`|Reserved for internal use by the common language runtime.| +|`evRTSpecialName`|Specifies that the common language runtime should check the encoding of the event name.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md new file mode 100644 index 0000000000000..ea5b9e9bce631 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md @@ -0,0 +1,88 @@ +--- +description: "Learn more about: CorFieldAttr Enumeration" +title: "CorFieldAttr Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorFieldAttr" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorFieldAttr" +helpviewer_keywords: + - "CorFieldAttr enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorFieldAttr Enumeration + +Contains values that describe metadata about a field. + +## Syntax + +```cpp +typedef enum CorFieldAttr { + + fdFieldAccessMask = 0x0007, + fdPrivateScope = 0x0000, + fdPrivate = 0x0001, + fdFamANDAssem = 0x0002, + fdAssembly = 0x0003, + fdFamily = 0x0004, + fdFamORAssem = 0x0005, + fdPublic = 0x0006, + + fdStatic = 0x0010, + fdInitOnly = 0x0020, + fdLiteral = 0x0040, + fdNotSerialized = 0x0080, + + fdSpecialName = 0x0200, + + fdPinvokeImpl = 0x2000, + + fdReservedMask = 0x9500, + fdRTSpecialName = 0x0400, + fdHasFieldMarshal = 0x1000, + fdHasDefault = 0x8000, + fdHasFieldRVA = 0x0100 + +} CorFieldAttr; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`fdFieldAccessMask`|Specifies accessibility information.| +|`fdPrivateScope`|Specifies that the field cannot be referenced.| +|`fdPrivate`|Specifies that the field is accessible only by its parent type.| +|`fdFamANDAssem`|Specifies that the field is accessible by derived classes in its assembly.| +|`fdAssembly`|Specifies that the field is accessible by all types in its assembly.| +|`fdFamily`|Specifies that the field is accessible only by its type and derived classes.| +|`fdFamORAssem`|Specifies that the field is accessible by derived classes and by all types in its assembly.| +|`fdPublic`|Specifies that the field is accessible by all types with visibility of this scope.| +|`fdStatic`|Specifies that the field is a member of its type rather than an instance member.| +|`fdInitOnly`|Specifies that the field cannot be changed after it is initialized.| +|`fdLiteral`|Specifies that the field value is a compile-time constant.| +|`fdNotSerialized`|Specifies that the field is not serialized when its type is remoted.| +|`fdSpecialName`|Specifies that the field is special, and that its name describes how.| +|`fdPinvokeImpl`|Specifies that the field implementation is forwarded through PInvoke.| +|`fdReservedMask`|Reserved for internal use by the common language runtime.| +|`fdRTSpecialName`|Specifies that the common language runtime metadata internal APIs should check the encoding of the name.| +|`fdHasFieldMarshal`|Specifies that the field contains marshalling information.| +|`fdHasDefault`|Specifies that the field has a default value.| +|`fdHasFieldRVA`|Specifies that the field has a relative virtual address.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md new file mode 100644 index 0000000000000..67bf745ba901b --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md @@ -0,0 +1,50 @@ +--- +description: "Learn more about: CorFileFlags Enumeration" +title: "CorFileFlags Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorFileFlags" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorFileFlags" +helpviewer_keywords: + - "CorFileFlags enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorFileFlags Enumeration + +Contains values that describe the type of file defined in a call to [IMetaDataAssemblyEmit::DefineFile](imetadataassemblyemit-definefile-method.md). + +## Syntax + +```cpp +typedef enum CorFileFlags { + + ffContainsMetaData = 0x0000, + ffContainsNoMetaData = 0x0001 + +} CorFileFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`ffContainsMetaData`|Indicates that the file is not a resource file.| +|`ffContainsNoMetaData`|Indicates that the file, possibly a resource file, does not contain metadata.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corfilemapping-enumeration.md b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/corfilemapping-enumeration.md rename to docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md index a2678433bf4cd..7f8ea128da64a 100644 --- a/docs/framework/unmanaged-api/metadata/corfilemapping-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md @@ -2,50 +2,49 @@ description: "Learn more about: CorFileMapping Enumeration" title: "CorFileMapping Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorFileMapping" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorFileMapping" -helpviewer_keywords: +helpviewer_keywords: - "CorFileMapping enumeration [.NET Framework metadata]" -ms.assetid: 3ca41592-b8da-475a-8032-a15627730003 -topic_type: +topic_type: - "apiref" --- # CorFileMapping Enumeration -Contains values that describe the type of file mapping that is returned from a call to the [IMetaDataInfo::GetFileMapping](imetadatainfo-getfilemapping-method.md) method. - -## Syntax - -```cpp -typedef enum CorFileMapping { - - fmFlat = 0x0000, - fmExecutableImage = 0x0001 - -} CorFileMapping; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`fmFlat`|The file is mapped as a data file. That is, the `SEC_IMAGE` flag was not passed to the Microsoft Win32 `CreateFileMapping` function.| -|`fmExecutableImage`|The file is mapped for execution, by using either the `LoadLibrary` function or the `CreateFileMapping` function with the `SEC_IMAGE` flag.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Contains values that describe the type of file mapping that is returned from a call to the [IMetaDataInfo::GetFileMapping](imetadatainfo-getfilemapping-method.md) method. + +## Syntax + +```cpp +typedef enum CorFileMapping { + + fmFlat = 0x0000, + fmExecutableImage = 0x0001 + +} CorFileMapping; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`fmFlat`|The file is mapped as a data file. That is, the `SEC_IMAGE` flag was not passed to the Microsoft Win32 `CreateFileMapping` function.| +|`fmExecutableImage`|The file is mapped for execution, by using either the `LoadLibrary` function or the `CreateFileMapping` function with the `SEC_IMAGE` flag.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md new file mode 100644 index 0000000000000..2ea2fd8b9d71c --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md @@ -0,0 +1,65 @@ +--- +description: "Learn more about: CorGenericParamAttr Enumeration" +title: "CorGenericParamAttr Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorGenericParamAttr" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorGenericParamAttr" +helpviewer_keywords: + - "CorGenericParamAttr enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorGenericParamAttr Enumeration + +Contains values that describe the parameters for generic types, as used in calls to [IMetaDataEmit2::DefineGenericParam](imetadataemit2-definegenericparam-method.md). + +## Syntax + +```cpp +typedef enum CorGenericParamAttr { + + gpVarianceMask = 0x0003, + gpNonVariant = 0x0000, + gpCovariant = 0x0001, + gpContravariant = 0x0002, + + gpSpecialConstraintMask = 0x001C, + gpNoSpecialConstraint = 0x0000, + gpReferenceTypeConstraint = 0x0004, + gpNotNullableValueTypeConstraint = 0x0008, + gpDefaultConstructorConstraint = 0x0010 + +} CorGenericParamAttr; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`gpVarianceMask`|Parameter variance applies only to generic parameters for interfaces and delegates.| +|`gpNonVariant`|Indicates the absence of variance.| +|`gpCovariant`|Indicates covariance.| +|`gpContravariant`|Indicates contravariance.| +|`gpSpecialConstraintMask`|Special constraints can apply to any parameter.| +|`gpNoSpecialConstraint`|Indicates that no constraint applies to the parameter.| +|`gpReferenceTypeConstraint`|Indicates that the parameter must be a reference type.| +|`gpNotNullableValueTypeConstraint`|Indicates that the parameter must be a value type that cannot be a null value.| +|`gpDefaultConstructorConstraint`|Indicates that the parameter must have a default public constructor that takes no parameters.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md new file mode 100644 index 0000000000000..eebd2be59b08e --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md @@ -0,0 +1,64 @@ +--- +description: "Learn more about: CorImportOptions Enumeration" +title: "CorImportOptions Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorImportOptions" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorImportOptions" +helpviewer_keywords: + - "CorImportOptions enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorImportOptions Enumeration + +Contains flag values that control the behavior during importation of an assembly outside the current scope. + +## Syntax + +```cpp +typedef enum CorImportOptions { + + MDImportOptionDefault = 0x00000000, + MDImportOptionAll = 0xFFFFFFFF, + MDImportOptionAllTypeDefs = 0x00000001, + MDImportOptionAllMethodDefs = 0x00000002, + MDImportOptionAllFieldDefs = 0x00000004, + MDImportOptionAllProperties = 0x00000008, + MDImportOptionAllEvents = 0x00000010, + MDImportOptionAllCustomAttributes = 0x00000020, + MDImportOptionAllExportedTypes = 0x00000040 + +} CorImportOptions; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MDImportOptionDefault`|Indicates the default behavior, which is to skip deleted records.| +|`MDImportOptionAll`|Indicates that all metadata should be enumerated.| +|`MDImportOptionAllTypeDefs`|Indicates that all TypeDefs, including deleted ones, should be enumerated.| +|`MDImportOptionAllMethodDefs`|Indicates that all MethodDefs, including deleted ones, should be enumerated.| +|`MDImportOptionAllFieldDefs`|Indicates that all FieldDefs, including deleted ones, should be enumerated.| +|`MDImportOptionAllProperties`|Indicates that all PropertyDefs, including deleted ones, should be enumerated.| +|`MDImportOptionAllEvents`|Indicates that all EventDefs, including deleted ones, should be enumerated.| +|`MDImportOptionAllCustomAttributes`|Indicates that all custom attributes, including deleted ones, should be enumerated.| +|`MDImportOptionAllExportedTypes`|Indicates that all exported types, including deleted ones, should be enumerated.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md new file mode 100644 index 0000000000000..4f82cc84479c7 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md @@ -0,0 +1,48 @@ +--- +description: "Learn more about: CorLinkerOptions Enumeration" +title: "CorLinkerOptions Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorLinkerOptions" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorLinkerOptions" +helpviewer_keywords: + - "CorLinkerOptions enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorLinkerOptions Enumeration + +Specifies flags to select options for the metadata linker. + +## Syntax + +```cpp +typedef enum CorLinkerOptions { + MDAssembly = 0x00000000, + MDNetModule = 0x00000001, +} CorLinkerOptions; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MDAssembly`|The private types and global functions are not preserved.| +|`MDNetModule`|The private types and global functions are preserved.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md new file mode 100644 index 0000000000000..485ee2aa8fe46 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md @@ -0,0 +1,51 @@ +--- +description: "Learn more about: CorLocalRefPreservation Enumeration" +title: "CorLocalRefPreservation Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorLocalRefPreservation" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorLocalRefPreservation" +helpviewer_keywords: + - "CorLocalRefPreservation enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorLocalRefPreservation Enumeration + +Contains flag values for the treatment of local references. + +## Syntax + +```cpp +typedef enum CorLocalRefPreservation +{ + MDPreserveLocalRefsNone = 0x00000000, + MDPreserveLocalTypeRef = 0x00000001, + MDPreserveLocalMemberRef = 0x00000002 +} CorLocalRefPreservation; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MDPreserveLocalRefsNone`|Preserve no local references.| +|`MDPreserveLocalTypeRef`|Preserve local type references.| +|`MDPreserveLocalMemberRef`|Preserve local member references.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md new file mode 100644 index 0000000000000..9ace935c7ba13 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md @@ -0,0 +1,52 @@ +--- +description: "Learn more about: CorManifestResourceFlags Enumeration" +title: "CorManifestResourceFlags Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorManifestResourceFlags" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorManifestResourceFlags" +helpviewer_keywords: + - "CorManifestResourceFlags enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorManifestResourceFlags Enumeration + +Indicates the visibility of resources encoded in an assembly manifest. + +## Syntax + +```cpp +typedef enum CorManifestResourceFlags { + + mrVisibilityMask = 0x0007, + mrPublic = 0x0001, + mrPrivate = 0x0002 + +} CorManifestResourceFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`mrVisibilityMask`|Reserved.| +|`mrPublic`|The resources are public.| +|`mrPrivate`|The resources are private.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md new file mode 100644 index 0000000000000..e2989854265b1 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md @@ -0,0 +1,99 @@ +--- +description: "Learn more about: CorMethodAttr Enumeration" +title: "CorMethodAttr Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorMethodAttr" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorMethodAttr" +helpviewer_keywords: + - "CorMethodAttr enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorMethodAttr Enumeration + +Contains values that describe the features of a method. + +## Syntax + +```cpp +typedef enum CorMethodAttr { + + mdMemberAccessMask = 0x0007, + mdPrivateScope = 0x0000, + mdPrivate = 0x0001, + mdFamANDAssem = 0x0002, + mdAssem = 0x0003, + mdFamily = 0x0004, + mdFamORAssem = 0x0005, + mdPublic = 0x0006, + + mdStatic = 0x0010, + mdFinal = 0x0020, + mdVirtual = 0x0040, + mdHideBySig = 0x0080, + + mdVtableLayoutMask = 0x0100, + mdReuseSlot = 0x0000, + mdNewSlot = 0x0100, + + mdCheckAccessOnOverride = 0x0200, + mdAbstract = 0x0400, + mdSpecialName = 0x0800, + + mdPinvokeImpl = 0x2000, + mdUnmanagedExport = 0x0008, + + mdReservedMask = 0xd000, + mdRTSpecialName = 0x1000, + mdHasSecurity = 0x4000, + mdRequireSecObject = 0x8000, + +} CorMethodAttr; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`mdMemberAccessMask`|Specifies member access.| +|`mdPrivateScope`|Specifies that the member cannot be referenced.| +|`mdPrivate`|Specifies that the member is accessible only by the parent type.| +|`mdFamANDAssem`|Specifies that the member is accessible by subtypes only in this assembly.| +|`mdAssem`|Specifies that the member is accessibly by anyone in the assembly.| +|`mdFamily`|Specifies that the member is accessible only by type and subtypes.| +|`mdFamORAssem`|Specifies that the member is accessible by derived classes and by other types in its assembly.| +|`mdPublic`|Specifies that the member is accessible by all types with access to the scope.| +|`mdStatic`|Specifies that the member is defined as part of the type rather than as a member of an instance.| +|`mdFinal`|Specifies that the method cannot be overridden.| +|`mdVirtual`|Specifies that the method can be overridden.| +|`mdHideBySig`|Specifies that the method hides by name and signature, rather than just by name.| +|`mdVtableLayoutMask`|Specifies virtual table layout.| +|`mdReuseSlot`|Specifies that the slot used for this method in the virtual table be reused. This is the default.| +|`mdNewSlot`|Specifies that the method always gets a new slot in the virtual table.| +|`mdCheckAccessOnOverride`|Specifies that the method can be overridden by the same types to which it is visible.| +|`mdAbstract`|Specifies that the method is not implemented.| +|`mdSpecialName`|Specifies that the method is special, and that its name describes how.| +|`mdPinvokeImpl`|Specifies that the method implementation is forwarded using PInvoke.| +|`mdUnmanagedExport`|Specifies that the method is a managed method exported to unmanaged code.| +|`mdReservedMask`|Reserved for internal use by the common language runtime.| +|`mdRTSpecialName`|Specifies that the common language runtime should check the encoding of the method name.| +|`mdHasSecurity`|Specifies that the method has security associated with it.| +|`mdRequireSecObject`|Specifies that the method calls another method containing security code.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cormethodimpl-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md similarity index 91% rename from docs/framework/unmanaged-api/metadata/cormethodimpl-enumeration.md rename to docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md index f487cd450ac27..8df215694fab8 100644 --- a/docs/framework/unmanaged-api/metadata/cormethodimpl-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md @@ -12,7 +12,6 @@ f1_keywords: - "CorMethodImpl" helpviewer_keywords: - "CorMethodImpl enumeration [.NET Framework metadata]" -ms.assetid: ffbb3caf-20da-4a4b-8983-77376e72b990 topic_type: - "apiref" --- @@ -71,11 +70,11 @@ typedef enum CorMethodImpl { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + **.NET versions:** Available since .NET Framework 1.0 ## See also diff --git a/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md new file mode 100644 index 0000000000000..488c2cec0c2dd --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: CorMethodSemanticsAttr Enumeration" +title: "CorMethodSemanticsAttr Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorMethodSemanticsAttr" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorMethodSemanticsAttr" +helpviewer_keywords: + - "CorMethodSemanticsAttr enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorMethodSemanticsAttr Enumeration + +Contains values that describe the relationship between a method and an associated property or event. + +## Syntax + +```cpp +typedef enum CorMethodSemanticsAttr { + + msSetter = 0x0001, + msGetter = 0x0002, + msOther = 0x0004, + msAddOn = 0x0008, + msRemoveOn = 0x0010, + msFire = 0x0020, + +} CorMethodSemanticsAttr; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`msSetter`|Specifies that the method is a `set` accessor for a property.| +|`msGetter`|Specifies that the method is a `get` accessor for a property.| +|`msOther`|Specifies that the method has a relationship to a property or an event other than those defined here.| +|`msAddOn`|Specifies that the method adds handler methods for an event.| +|`msRemoveOn`|Specifies that the method removes handler methods for an event.| +|`msFire`|Specifies that the method raises an event.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md new file mode 100644 index 0000000000000..65578e1c0ceb0 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md @@ -0,0 +1,55 @@ +--- +description: "Learn more about: CorNativeLinkFlags Enumeration" +title: "CorNativeLinkFlags Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorNativeLinkFlags" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorNativeLinkFlags" +helpviewer_keywords: + - "CorNativeLinkFlags enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorNativeLinkFlags Enumeration + +Provides flag values used by the linker when linking native code. + +## Syntax + +```cpp +typedef enum +{ + nlfNone = 0x00, + nlfLastError = 0x01, + nlfNoMangle = 0x02, + nlfMaxValue = 0x03 +} CorNativeLinkFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`nlfNone`|Indicates no flags.| +|`nlfLastError`|Indicates a `setLastError` keyword.| +|`nlfNoMangle`|Indicates a `nomangle` keyword.| +|`nlfMaxValue`|Not used.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md new file mode 100644 index 0000000000000..541da13cee47b --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md @@ -0,0 +1,59 @@ +--- +description: "Learn more about: CorNativeLinkType Enumeration" +title: "CorNativeLinkType Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorNativeLinkType" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorNativeLinkType" +helpviewer_keywords: + - "CorNativeLinkType enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorNativeLinkType Enumeration + +Provides values that indicate the type linked in native code. + +## Syntax + +```cpp +typedef enum +{ + nltNone = 1, + nltAnsi = 2, + nltUnicode = 3, + nltAuto = 4, + nltOle = 5, + nltMaxValue = 7 +} CorNativeLinkType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`nltNone`|Indicates that none of the keywords are specified.| +|`nltAnsi`|Indicates that an ANSI keyword is specified.| +|`nltUnicode`|Indicates that a Unicode keyword is specified| +|`nltAuto`|Indicates that an auto keyword is specified.| +|`nltOle`|Indicates that an OLE keyword is specified.| +|`nltMaxValue`|Not used.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md new file mode 100644 index 0000000000000..d08823c79690f --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md @@ -0,0 +1,146 @@ +--- +description: "Learn more about: CorNativeType Enumeration" +title: "CorNativeType Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorNativeType" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorNativeType" +helpviewer_keywords: + - "CorNativeType enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorNativeType Enumeration + +Contains values that describe native unmanaged types. + +## Syntax + +```cpp +typedef enum CorNativeType { + + NATIVE_TYPE_END = 0x0, + NATIVE_TYPE_VOID = 0x1, + NATIVE_TYPE_BOOLEAN = 0x2, + NATIVE_TYPE_I1 = 0x3, + NATIVE_TYPE_U1 = 0x4, + NATIVE_TYPE_I2 = 0x5, + NATIVE_TYPE_U2 = 0x6, + NATIVE_TYPE_I4 = 0x7, + NATIVE_TYPE_U4 = 0x8, + NATIVE_TYPE_I8 = 0x9, + NATIVE_TYPE_U8 = 0xa, + NATIVE_TYPE_R4 = 0xb, + NATIVE_TYPE_R8 = 0xc, + NATIVE_TYPE_SYSCHAR = 0xd, + NATIVE_TYPE_VARIANT = 0xe, + NATIVE_TYPE_CURRENCY = 0xf, + NATIVE_TYPE_PTR = 0x10, + + NATIVE_TYPE_DECIMAL = 0x11, + NATIVE_TYPE_DATE = 0x12, + NATIVE_TYPE_BSTR = 0x13, + NATIVE_TYPE_LPSTR = 0x14, + NATIVE_TYPE_LPWSTR = 0x15, + NATIVE_TYPE_LPTSTR = 0x16, + NATIVE_TYPE_FIXEDSYSSTRING = 0x17, + NATIVE_TYPE_OBJECTREF = 0x18, + NATIVE_TYPE_IUNKNOWN = 0x19, + NATIVE_TYPE_IDISPATCH = 0x1a, + NATIVE_TYPE_STRUCT = 0x1b, + NATIVE_TYPE_INTF = 0x1c, + NATIVE_TYPE_SAFEARRAY = 0x1d, + NATIVE_TYPE_FIXEDARRAY = 0x1e, + NATIVE_TYPE_INT = 0x1f, + NATIVE_TYPE_UINT = 0x20, + + NATIVE_TYPE_NESTEDSTRUCT = 0x21, + NATIVE_TYPE_BYVALSTR = 0x22, + NATIVE_TYPE_ANSIBSTR = 0x23, + NATIVE_TYPE_TBSTR = 0x24, + NATIVE_TYPE_VARIANTBOOL = 0x25, + NATIVE_TYPE_FUNC = 0x26, + + NATIVE_TYPE_ASANY = 0x28, + NATIVE_TYPE_ARRAY = 0x2a, + NATIVE_TYPE_LPSTRUCT = 0x2b, + NATIVE_TYPE_CUSTOMMARSHALER = 0x2c, + NATIVE_TYPE_IINSPECTABLE = 0x2e, + NATIVE_TYPE_HSTRING = 0x2f, + + NATIVE_TYPE_ERROR = 0x2d, + + NATIVE_TYPE_MAX = 0x50 + +} CorNativeType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`NATIVE_TYPE_END`|Obsolete.| +|`NATIVE_TYPE_VOID`|Obsolete.| +|`NATIVE_TYPE_BOOLEAN`|A 4-byte Boolean value, where TRUE is non-zero and FALSE is zero.| +|`NATIVE_TYPE_I1`|A signed 8-bit integer value.| +|`NATIVE_TYPE_U1`|An unsigned 8-bit integer value.| +|`NATIVE_TYPE_I2`|A signed 16-bit integer value.| +|`NATIVE_TYPE_U2`|An unsigned 16-bit integer value.| +|`NATIVE_TYPE_I4`|A signed 32-bit integer value.| +|`NATIVE_TYPE_U4`|An unsigned 32-bit integer value.| +|`NATIVE_TYPE_I8`|A signed 64-bit integer value.| +|`NATIVE_TYPE_U8`|An unsigned 64-bit integer value.| +|`NATIVE_TYPE_R4`|A 4-byte floating-point numeric value.| +|`NATIVE_TYPE_R8`|An 8-byte floating-point numeric value.| +|`NATIVE_TYPE_SYSCHAR`|Obsolete.| +|`NATIVE_TYPE_VARIANT`|Obsolete.| +|`NATIVE_TYPE_CURRENCY`|A numeric COM type that corresponds to the managed type.| +|`NATIVE_TYPE_PTR`|Obsolete.| +|`NATIVE_TYPE_DECIMAL`|Obsolete.| +|`NATIVE_TYPE_DATE`|Obsolete.| +|`NATIVE_TYPE_BSTR`|COM Interop.| +|`NATIVE_TYPE_LPSTR`|An LPSTR string value.| +|`NATIVE_TYPE_LPWSTR`|An LPWSTR string value.| +|`NATIVE_TYPE_LPTSTR`|An LPTSTR string value.| +|`NATIVE_TYPE_FIXEDSYSSTRING`|A fixed, system-defined string value.| +|`NATIVE_TYPE_OBJECTREF`|Obsolete.| +|`NATIVE_TYPE_IUNKNOWN`|COM Interop.| +|`NATIVE_TYPE_IDISPATCH`|COM Interop.| +|`NATIVE_TYPE_STRUCT`|A native structure value.| +|`NATIVE_TYPE_INTF`|COM Interop.| +|`NATIVE_TYPE_SAFEARRAY`|COM Interop.| +|`NATIVE_TYPE_FIXEDARRAY`|A fixed-length array value.| +|`NATIVE_TYPE_INT`|A native 16-bit signed integer value.| +|`NATIVE_TYPE_UINT`|A native 16-bit unsigned integer value.| +|`NATIVE_TYPE_NESTEDSTRUCT`|Obsolete.

Use NATIVE_TYPE_STRUCT.| +|`NATIVE_TYPE_BYVALSTR`|COM Interop.| +|`NATIVE_TYPE_ANSIBSTR`|COM Interop.| +|`NATIVE_TYPE_TBSTR`|COM Interop.

Select BSTR or ANSIBSTR depending on the platform.| +|`NATIVE_TYPE_VARIANTBOOL`|A 2-byte Boolean value, where TRUE is -1 and FALSE is zero.| +|`NATIVE_TYPE_FUNC`|A function pointer.| +|`NATIVE_TYPE_ASANY`|A reference to any native type.| +|`NATIVE_TYPE_ARRAY`|A reference to an array with members of an unspecified type.| +|`NATIVE_TYPE_LPSTRUCT`|A 32-bit integer pointer to a structure.| +|`NATIVE_TYPE_CUSTOMMARSHALER`|A custom marshaller native type.

This must be followed by a string of the following format: "Native type name/0Custom marshaller type name/0Optional cookie/0" or "{Native type GUID}/0Custom marshaller type name/0Optional cookie/0"| +|`NATIVE_TYPE_ERROR`|COM Interop.

With ELEMENT_TYPE_I4 this type maps to VT_HRESULT.| +|`NATIVE_TYPE_IINSPECTABLE`|A native `IInspectable` type.| +|`NATIVE_TYPE_HSTRING`|A native `HString`.| +|`NATIVE_TYPE_MAX`|An invalid value.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md new file mode 100644 index 0000000000000..cff99da82d74f --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md @@ -0,0 +1,99 @@ +--- +description: "Learn more about: CorNotificationForTokenMovement Enumeration" +title: "CorNotificationForTokenMovement Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorNotificationForTokenMovement" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorNotificationForTokenMovement" +helpviewer_keywords: + - "CorNotificationForTokenMovement enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorNotificationForTokenMovement Enumeration + +Specifies the notifications that will be sent to the metadata API client when a token remap occurs. + +## Syntax + +```cpp +typedef enum CorNotificationForTokenMovement { + + MDNotifyDefault = 0x0000000f, + MDNotifyAll = 0xffffffff, + MDNotifyNone = 0x00000000, + MDNotifyMethodDef = 0x00000001, + MDNotifyMemberRef = 0x00000002, + MDNotifyFieldDef = 0x00000004, + MDNotifyTypeRef = 0x00000008, + + MDNotifyTypeDef = 0x00000010, + MDNotifyParamDef = 0x00000020, + MDNotifyInterfaceImpl = 0x00000040, + MDNotifyProperty = 0x00000080, + MDNotifyEvent = 0x00000100, + MDNotifySignature = 0x00000200, + MDNotifyTypeSpec = 0x00000400, + MDNotifyCustomAttribute = 0x00000800, + MDNotifySecurityValue = 0x00001000, + MDNotifyPermission = 0x00002000, + MDNotifyModuleRef = 0x00004000, + + MDNotifyNameSpace = 0x00008000, + + MDNotifyAssemblyRef = 0x01000000, + MDNotifyFile = 0x02000000, + MDNotifyExportedType = 0x04000000, + MDNotifyResource = 0x08000000 + +} CorNotificationForTokenMovement; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MDNotifyDefault`|Notify when `mdTypeRef`, `mdMethodDef`, `mdMemberRef`, or `mdFieldDef` tokens move.| +|`MDNotifyAll`|Notify when any token moves.| +|`MDNotifyNone`|Do not notify when tokens move.| +|`MDNotifyMethodDef`|Notify when an `mdMethodDef` token moves.| +|`MDNotifyMemberRef`|Notify when an `mdMemberRef` token moves.| +|`MDNotifyFieldDef`|Notify when an `mdFieldDef` token moves.| +|`MDNotifyTypeRef`|Notify when an `mdTypeRef` token moves.| +|`MDNotifyTypeDef`|Notify when an `mdTypeDef` token moves.| +|`MDNotifyParamDef`|Notify when an `mdParamDef` token moves.| +|`MDNotifyInterfaceImpl`|Notify when an `mdInterfaceImpl` token moves.| +|`MDNotifyProperty`|Notify when an `mdProperty` token moves.| +|`MDNotifyEvent`|Notify when an `mdEvent` token moves.| +|`MDNotifySignature`|Notify when an `mdSignature` token moves.| +|`MDNotifyTypeSpec`|Notify when an `mdTypeSpec` token moves.| +|`MDNotifyCustomAttribute`|Notify when an `mdCustomAttribute` token moves.| +|`MDNotifySecurityValue`|Notify when an `mdSecurityValue` token moves.| +|`MDNotifyPermission`|Notify when an `mdPermission` token moves.| +|`MDNotifyModuleRef`|Notify when an `mdModuleRef` token moves.| +|`MDNotifyNameSpace`|Notify when an `mdNameSpace` token moves.| +|`MDNotifyAssemblyRef`|Notify when an `mdAssemblyRef` token moves.| +|`MDNotifyFile`|Notify when an `mdFile` token moves.| +|`MDNotifyExportedType`|Notify when an `mdExportedType` token moves.| +|`MDNotifyResource`|Notify when an `mdManifestResource` token moves.| + +## Remarks + + A token may be re-mapped (that is, moved) during a metadata merge. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md new file mode 100644 index 0000000000000..2a5b5306d73c7 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: CorOpenFlags Enumeration" +title: "CorOpenFlags Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorOpenFlags" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorOpenFlags" +helpviewer_keywords: + - "CorOpenFlags enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorOpenFlags Enumeration + +Contains flag values that control metadata behavior upon opening manifest files. + +## Syntax + +```cpp +typedef enum CorOpenFlags +{ + ofRead = 0x00000000, + ofWrite = 0x00000001, + ofReadWriteMask = 0x00000001, + ofCopyMemory = 0x00000002, + ofCacheImage = 0x00000004, + ofManifestMetadata = 0x00000008, + ofReadOnly = 0x00000010, + ofTakeOwnership = 0x00000020, + ofCacheImage = 0x00000004, + ofNoTypeLib = 0x00000080, + ofNoTransform = 0x00001000, + ofReserved1 = 0x00000100, + ofReserved2 = 0x00000200, + ofReserved = 0xffffff40 +} CorOpenFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`ofRead`|Indicates that the file should be opened for reading only.| +|`ofWrite`|Indicates that the file should be opened for writing.

If you are using the `ofWrite` flag when opening a .winmd file, you should also pass the `ofNoTransform` flag.| +|`ofReadWriteMask`|A mask for reading and writing.| +|`ofCopyMemory`|Indicates that the file should be read into memory. Metadata should maintain its own copy.| +|`ofCacheImage`|Obsolete. This flag is ignored.| +|`ofManifestMetadata`|Obsolete. This flag is ignored.| +|`ofReadOnly`|Indicates that the file should be opened for reading, and that a call to `QueryInterface` for an [IMetaDataEmit](imetadataemit-interface.md) cannot be made.| +|`ofTakeOwnership`|Indicates that the memory was allocated using a call to [CoTaskMemAlloc](/windows/desktop/api/combaseapi/nf-combaseapi-cotaskmemalloc) and will be freed by the metadata.| +|`ofNoTypeLib`|Obsolete. This flag is ignored.| +|`ofNoTransform`|Indicates that automatic transforms of .winmd files should be disabled. In other words, the projection of a Windows Runtime type to a .NET Framework type should be disabled. For more information, see [Windows Runtime and the CLR - Underneath the Hood with .NET and the Windows Runtime](/archive/msdn-magazine/2012/windows-8-special-issue/windows-runtime-and-the-clr-underneath-the-hood-with-net-and-the-windows-runtime).| +|`ofReserved1`|Reserved for internal use.| +|`ofReserved2`|Reserved for internal use.| +|`ofReserved`|Reserved for internal use.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md new file mode 100644 index 0000000000000..bc8b4e4878797 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md @@ -0,0 +1,62 @@ +--- +description: "Learn more about: CorParamAttr Enumeration" +title: "CorParamAttr Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorParamAttr" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorParamAttr" +helpviewer_keywords: + - "CorParamAttr enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorParamAttr Enumeration + +Contains values that describe the metadata of a method parameter. + +## Syntax + +```cpp +typedef enum CorParamAttr { + + pdIn = 0x0001, + pdOut = 0x0002, + pdOptional = 0x0010, + + pdReservedMask = 0xf000, + pdHasDefault = 0x1000, + pdHasFieldMarshal = 0x2000, + + pdUnused = 0xcfe0 + +} CorParamAttr; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`pdIn`|Specifies that the parameter is passed into the method call.| +|`pdOut`|Specifies that the parameter is passed from the method return.| +|`pdOptional`|Specifies that the parameter is optional.| +|`pdReservedMask`|Reserved for internal use by the common language runtime.| +|`pdHasDefault`|Specifies that the parameter has a default value.| +|`pdHasFieldMarshal`|Specifies that the parameter has marshalling information.| +|`pdUnused`|Unused.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corpekind-enumeration.md b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md new file mode 100644 index 0000000000000..91afd048eec55 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md @@ -0,0 +1,62 @@ +--- +description: "Learn more about: CorPEKind Enumeration" +title: "CorPEKind Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorPEKind" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorPEKind" +helpviewer_keywords: + - "CorPEKind enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorPEKind Enumeration + +Contains values that describe a portable executable (PE) file, as returned from a call to [IMetaDataImport2::GetPEKind](imetadataimport2-getpekind-method.md). + +## Syntax + +```cpp +typedef enum CorPEKind { + + peNot = 0x00000000, + peILonly = 0x00000001, + pe32BitRequired = 0x00000002, + pe32Plus = 0x00000004, + pe32Unmanaged = 0x00000008, + pe32BitPreferred= 0x00000010 + +} CorPEKind; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`peNot`|Indicates that this is not a PE file.| +|`peILOnly`|Indicates that this PE file contains only managed code.| +|`pe32BitRequired`|Indicates that this PE file makes Win32 calls.| +|`pe32Plus`|Indicates that this PE file runs on a 64-bit platform.| +|`pe32Unmanaged`|Indicates that this PE file is native code.| +|pe32BitPreferred|Indicates that this PE file is platform-neutral and prefers to be loaded in a 32-bit environment.| + +## Remarks + + These values can be used in bitwise combinations. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md new file mode 100644 index 0000000000000..695e91a4cb8a4 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md @@ -0,0 +1,96 @@ +--- +description: "Learn more about: CorPinvokeMap Enumeration" +title: "CorPinvokeMap Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorPinvokeMap" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorPinvokeMap" +helpviewer_keywords: + - "CorPinvokeMap enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorPinvokeMap Enumeration + +Specifies options for a PInvoke call. + +## Syntax + +```cpp +typedef enum CorPinvokeMap { + + pmNoMangle = 0x0001, + + pmCharSetMask = 0x0006, + pmCharSetNotSpec = 0x0000, + pmCharSetAnsi = 0x0002, + pmCharSetUnicode = 0x0004, + pmCharSetAuto = 0x0006, + + pmBestFitUseAssem = 0x0000, + pmBestFitEnabled = 0x0010, + pmBestFitDisabled = 0x0020, + pmBestFitMask = 0x0030, + + pmThrowOnUnmappableCharUseAssem = 0x0000, + pmThrowOnUnmappableCharEnabled = 0x1000, + pmThrowOnUnmappableCharDisabled = 0x2000, + pmThrowOnUnmappableCharMask = 0x3000, + + pmSupportsLastError = 0x0040, + + pmCallConvMask = 0x0700, + pmCallConvWinapi = 0x0100, + pmCallConvCdecl = 0x0200, + pmCallConvStdcall = 0x0300, + pmCallConvThiscall = 0x0400, + pmCallConvFastcall = 0x0500, + + pmMaxValue = 0xFFFF + +} CorPinvokeMap; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`pmNoMangle`|Use each member name as specified.| +|`pmCharSetMask`|Reserved.| +|`pmCharSetNotSpec`|Reserved.| +|`pmCharSetAnsi`|Marshal strings as multiple-byte character strings.| +|`pmCharSetUnicode`|Marshal strings as Unicode 2-byte characters.| +|`pmCharSetAuto`|Automatically marshal strings appropriately for the target operating system. The default is Unicode on Windows.| +|`pmBestFitUseAssem`|Reserved.| +|`pmBestFitEnabled`|Perform best-fit mapping of Unicode characters that lack an exact match in the ANSI character set.| +|`pmBestFitDisabled`|Do not perform best-fit mapping of Unicode characters. In this case, all unmappable characters will be replaced by a ‘?’.| +|`pmBestFitMask`|Reserved.| +|`pmThrowOnUnmappableCharUseAssem`|Reserved.| +|`pmThrowOnUnmappableCharEnabled`|Throw an exception when the interop marshaller encounters an unmappable character.| +|`pmThrowOnUnmappableCharDisabled`|Do not throw an exception when the interop marshaller encounters an unmappable character.| +|`pmThrowOnUnmappableCharMask`|Reserved| +|`pmSupportsLastError`|Allow the callee to call the Win32 `SetLastError` function before returning from the attributed method.| +|`pmCallConvMask`|Reserved| +|`pmCallConvWinapi`|Use the default platform calling convention. For example, on Windows the default is `StdCall` and on Windows CE .NET it is `Cdecl`.| +|`pmCallConvCdecl`|Use the `Cdecl` calling convention. In this case, the caller cleans the stack. This enables calling functions with `varargs` (that is, functions that accept a variable number of parameters).| +|`pmCallConvStdcall`|Use the `StdCall` calling convention. In this case, the callee cleans the stack. This is the default convention for calling unmanaged functions with platform invoke.| +|`pmCallConvThiscall`|Use the `ThisCall` calling convention. In this case, the first parameter is the `this` pointer and is stored in register ECX. Other parameters are pushed on the stack. The `ThisCall` calling convention is used to call methods on classes exported from an unmanaged DLL.| +|`pmCallConvFastcall`|Reserved.| +|`pmMaxValue`|Reserved.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md new file mode 100644 index 0000000000000..c8f291e745526 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md @@ -0,0 +1,56 @@ +--- +description: "Learn more about: CorPropertyAttr Enumeration" +title: "CorPropertyAttr Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorPropertyAttr" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorPropertyAttr" +helpviewer_keywords: + - "CorPropertyAttr enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorPropertyAttr Enumeration + +Contains values that describe the metadata of a property. + +## Syntax + +```cpp +typedef enum CorPropertyAttr { + + prSpecialName = 0x0200, + prReservedMask = 0xf400, + prRTSpecialName = 0x0400, + prHasDefault = 0x1000, + prUnused = 0xe9ff + +} CorPropertyAttr; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`prSpecialName`|Specifies that the property is special, and that its name describes how.| +|`prReservedMask`|Reserved for internal use by the common language runtime.| +|`prRTSpecialName`|Specifies that the common language runtime metadata internal APIs should check the encoding of the property name.| +|`prHasDefault`|Specifies that the property has a default value.| +|`prUnused`|Unused.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md new file mode 100644 index 0000000000000..2748e7b2fc59a --- /dev/null +++ b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md @@ -0,0 +1,54 @@ +--- +description: "Learn more about: CorRefToDefCheck Enumeration" +title: "CorRefToDefCheck Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorRefToDefCheck" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorRefToDefCheck" +helpviewer_keywords: + - "CorRefToDefCheck enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorRefToDefCheck Enumeration + +Specifies flags to control which referenced items are converted to their definitions in order to optimize the code. + +## Syntax + +```cpp +typedef enum CorRefToDefCheck { + MDRefToDefDefault = 0x00000003, + MDRefToDefAll = 0xffffffff, + MDRefToDefNone = 0x00000000, + MDTypeRefToDef = 0x00000001, + MDMemberRefToDef = 0x00000002 +} CorRefToDefCheck; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MDRefToDefDefault`|Specifies that type references and member references should be converted to definitions. This is the default value (`MDTypeRefToDef` | `MDMemberRefToDef`).| +|`MDRefToDefAll`|Specifies that all referenced items should be converted to definitions.| +|`MDRefToDefNone`|Specifies that no referenced items should be converted to definitions.| +|`MDTypeRefToDef`|Specifies that only type references should be converted to type definitions.| +|`MDMemberRefToDef`|Specifies that only member references should be converted to definitions. That is, member references should be converted to either method definitions or field definitions.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corregflags-enumeration.md b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md new file mode 100644 index 0000000000000..05e754478a5a4 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: CorRegFlags Enumeration" +title: "CorRegFlags Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorRegFlags" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorRegFlags" +helpviewer_keywords: + - "CorRegFlags enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorRegFlags Enumeration + +Provides flag values used for registration when installing a module or composite image. + +## Syntax + +```cpp +typedef enum +{ + regNoCopy = 0x00000001, + regConfig = 0x00000002, + regHasRefs = 0x00000004 +} CorRegFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`regNoCopy`|Specifies that files should not be copied into the destination.| +|`regConfig`|Specifies that the module or composite is a configuration.| +|`regHasRefs`|Specifies that the module or composite has class references.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md new file mode 100644 index 0000000000000..dbbf3c9c38231 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md @@ -0,0 +1,52 @@ +--- +description: "Learn more about: CorSaveSize Enumeration" +title: "CorSaveSize Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorSaveSize" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorSaveSize" +helpviewer_keywords: + - "CorSaveSize enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorSaveSize Enumeration + +Contains values indicating the level of precision required when querying for the size of a save operation. + +## Syntax + +```cpp +typedef enum CorSaveSize { + cssAccurate = 0x0000, + cssQuick = 0x0001, + cssDiscardTransientCAs = 0x0002 +} CorSaveSize; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`cssAccurate`|Specifies that the return value should be exact.| +|`cssQuick`|Specifies that the return value should be estimated.| +|`cssDiscardTransientCAs`|Specifies that discardable types should be removed.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md new file mode 100644 index 0000000000000..f326613186d36 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md @@ -0,0 +1,86 @@ +--- +description: "Learn more about: CorSerializationType Enumeration" +title: "CorSerializationType Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorSerializationType" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorSerializationType" +helpviewer_keywords: + - "CorSerializationType enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorSerializationType Enumeration + +Specifies how an object is serialized by the common language runtime. + +## Syntax + +```cpp +typedef enum CorSerializationType { + + SERIALIZATION_TYPE_UNDEFINED = 0, + SERIALIZATION_TYPE_BOOLEAN = ELEMENT_TYPE_BOOLEAN, + SERIALIZATION_TYPE_CHAR = ELEMENT_TYPE_CHAR, + SERIALIZATION_TYPE_I1 = ELEMENT_TYPE_I1, + SERIALIZATION_TYPE_U1 = ELEMENT_TYPE_U1, + SERIALIZATION_TYPE_I2 = ELEMENT_TYPE_I2, + SERIALIZATION_TYPE_U2 = ELEMENT_TYPE_U2, + SERIALIZATION_TYPE_I4 = ELEMENT_TYPE_I4, + SERIALIZATION_TYPE_U4 = ELEMENT_TYPE_U4, + SERIALIZATION_TYPE_I8 = ELEMENT_TYPE_I8, + SERIALIZATION_TYPE_U8 = ELEMENT_TYPE_U8, + SERIALIZATION_TYPE_R4 = ELEMENT_TYPE_R4, + SERIALIZATION_TYPE_R8 = ELEMENT_TYPE_R8, + SERIALIZATION_TYPE_STRING = ELEMENT_TYPE_STRING, + SERIALIZATION_TYPE_SZARRAY = ELEMENT_TYPE_SZARRAY, + SERIALIZATION_TYPE_TYPE = 0x50, + SERIALIZATION_TYPE_TAGGED_OBJECT = 0x51, + SERIALIZATION_TYPE_FIELD = 0x53, + SERIALIZATION_TYPE_PROPERTY = 0x54, + SERIALIZATION_TYPE_ENUM = 0x55 + +} CorSerializationType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`SERIALIZATION_TYPE_UNDEFINED`|Serialization of the object is undefined.| +|`SERIALIZATION_TYPE_BOOLEAN`|Object is serialized as a Boolean type| +|`SERIALIZATION_TYPE_CHAR`|Object is serialized as a character type.| +|`SERIALIZATION_TYPE_I1`|Object is serialized as a signed 1-byte integer.| +|`SERIALIZATION_TYPE_U1`|Object is serialized as an unsigned 1-byte integer.| +|`SERIALIZATION_TYPE_I2`|Object is serialized as a signed 2-byte integer.| +|`SERIALIZATION_TYPE_U2`|Object is serialized as an unsigned 2-byte integer.| +|`SERIALIZATION_TYPE_I4`|Object is serialized as a signed 4-byte integer.| +|`SERIALIZATION_TYPE_U4`|Object is serialized as an unsigned 4-byte integer.| +|`SERIALIZATION_TYPE_I8`|Object is serialized as a signed 8-byte integer.| +|`SERIALIZATION_TYPE_U8`|Object is serialized as an unsigned 8-byte integer.| +|`SERIALIZATION_TYPE_R4`|Object is serialized as a 4-byte floating point.| +|`SERIALIZATION_TYPE_R8`|Object is serialized as an 8-byte floating point.| +|`SERIALIZATION_TYPE_STRING`|Object is serialized as a System.String type.| +|`SERIALIZATION_TYPE_SZARRAY`|Object is serialized as a single-dimensional, zero lower-bound array.| +|`SERIALIZATION_TYPE_TYPE`|Object is serialized as a generic type.| +|`SERIALIZATION_TYPE_TAGGED_OBJECT`|Object is serialized as a tagged object.| +|`SERIALIZATION_TYPE_FIELD`|Object is serialized as a field.| +|`SERIALIZATION_TYPE_PROPERTY`|Object is serialized as a property.| +|`SERIALIZATION_TYPE_ENUM`|Object is serialized as an enumeration.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md new file mode 100644 index 0000000000000..be243d8b856ec --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md @@ -0,0 +1,63 @@ +--- +description: "Learn more about: CorSetENC Enumeration" +title: "CorSetENC Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorSetENC" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorSetENC" +helpviewer_keywords: + - "CorSetENC enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorSetENC Enumeration + +Contains values used to influence behavior during the generation of metadata. + +## Syntax + +```cpp +typedef enum CorSetENC { + + MDSetENCOn = 0x00000001, + MDSetENCOff = 0x00000002, + + MDUpdateENC = 0x00000001, + MDUpdateFull = 0x00000002, + MDUpdateExtension = 0x00000003, + MDUpdateIncremental = 0x00000004, + MDUpdateDelta = 0x00000005, + MDUpdateMask = 0x00000007 + +} CorSetENC; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MDSetENCOn`|Obsolete.| +|`MDSetENCOff`|Obsolete.| +|`MDUpdateENC`|Indicates that whereas metadata can be updated, tokens cannot be moved.| +|`MDUpdateFull`|Indicates that tokens can be moved during updates.| +|`MDUpdateExtension`|Indicates that updates can consist only of additions. Tokens cannot be moved.| +|`MDUpdateIncremental`|Indicates that compilation is incremental.| +|`MDUpdateDelta`|Indicates that only changed metadata should be saved.| +|`MDUpdateMask`|Includes `MDUpdateENC`, `MDUpdateFull` and `MDUpdateIncremental`.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md similarity index 81% rename from docs/framework/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md rename to docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md index 162b6fae57c27..3113fd165212f 100644 --- a/docs/framework/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md @@ -12,7 +12,6 @@ f1_keywords: - "CorThreadSafetyOptions" helpviewer_keywords: - "CorThreadSafetyOptions enumeration [.NET Framework metadata]" -ms.assetid: dae07d9b-df51-488c-b17e-52d6e48217bd topic_type: - "apiref" --- @@ -41,11 +40,11 @@ typedef enum CorThreadSafetyOptions { ## Requirements -**Platforms:** See [System Requirements](../../get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h -**.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] +**.NET versions:** Available since .NET Framework 1.0 ## See also diff --git a/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md new file mode 100644 index 0000000000000..da7785869dbec --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md @@ -0,0 +1,102 @@ +--- +description: "Learn more about: CorTokenType Enumeration" +title: "CorTokenType Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorTokenType" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorTokenType" +helpviewer_keywords: + - "CorTokenType enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorTokenType Enumeration + +Indicates the type of a metadata token. + +## Syntax + +```cpp +typedef enum CorTokenType { + + mdtModule = 0x00000000, + mdtTypeRef = 0x01000000, + mdtTypeDef = 0x02000000, + mdtFieldDef = 0x04000000, + mdtMethodDef = 0x06000000, + mdtParamDef = 0x08000000, + mdtInterfaceImpl = 0x09000000, + mdtMemberRef = 0x0a000000, + mdtCustomAttribute = 0x0c000000, + mdtPermission = 0x0e000000, + mdtSignature = 0x11000000, + mdtEvent = 0x14000000, + mdtProperty = 0x17000000, + mdtModuleRef = 0x1a000000, + mdtTypeSpec = 0x1b000000, + mdtAssembly = 0x20000000, + mdtAssemblyRef = 0x23000000, + mdtFile = 0x26000000, + mdtExportedType = 0x27000000, + mdtManifestResource = 0x28000000, + mdtGenericParam = 0x2a000000, + mdtMethodSpec = 0x2b000000, + mdtGenericParamConstraint = 0x2c000000, + mdtString = 0x70000000, + mdtName = 0x71000000, + mdtBaseType = 0x72000000 + +} CorTokenType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`mdtModule`|An `mdModule` token.| +|`mdtTypeRef`|An `mdTypeRef` token.| +|`mdtTypeDef`|An `mdTypeDef` token.| +|`mdtFieldDef`|An `mdFieldDef` token.| +|`mdtMethodDef`|An `mdMethodDef` token.| +|`mdtParamDef`|An `mdParamDef` token.| +|`mdtInterfaceImpl`|An `mdInterfaceImpl` token.| +|`mdtMemberRef`|An `mdMemberRef` token.| +|`mdtCustomAttribute`|An `mdCustomAttribute` token.| +|`mdtPermission`|An `mdPermission` token.| +|`mdtSignature`|An `mdSignature` token.| +|`mdtEvent`|An `mdEvent` token.| +|`mdtProperty`|An `mdProperty` token.| +|`mdtModuleRef`|An `mdModuleRef` token.| +|`mdtTypeSpec`|An `mdTypeSpec` token.| +|`mdtAssembly`|An `mdAssembly` token.| +|`mdtAssemblyRef`|An `mdAssemblyRef` token.| +|`mdtFile`|An `mdFile` token.| +|`mdtExportedType`|An `mdExportedType` token.| +|`mdtManifestResource`|An `mdManifestResource` token.| +|`mdtGenericParam`|An `mdGenericParam` token.| +|`mdtMethodSpec`|An `mdMethodSpec` token.| +|`mdtGenericParamConstraint`|An `mdGenericParamConstraint` token.| +|`mdtString`|An `mdString` token.| +|`mdtName`|An `mdName` token.| +|`mdtBaseType`|Not used.| + +## Remarks + + Each value is equal to the value of the top byte in the corresponding metadata token. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md new file mode 100644 index 0000000000000..7c7c7af51a70c --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md @@ -0,0 +1,119 @@ +--- +description: "Learn more about: CorTypeAttr Enumeration" +title: "CorTypeAttr Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorTypeAttr" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorTypeAttr" +helpviewer_keywords: + - "CorTypeAttr enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorTypeAttr Enumeration + +Contains values that indicate type metadata. + +## Syntax + +```cpp +typedef enum CorTypeAttr { + + tdVisibilityMask = 0x00000007, + tdNotPublic = 0x00000000, + tdPublic = 0x00000001, + tdNestedPublic = 0x00000002, + tdNestedPrivate = 0x00000003, + tdNestedFamily = 0x00000004, + tdNestedAssembly = 0x00000005, + tdNestedFamANDAssem = 0x00000006, + tdNestedFamORAssem = 0x00000007, + + tdLayoutMask = 0x00000018, + tdAutoLayout = 0x00000000, + tdSequentialLayout = 0x00000008, + tdExplicitLayout = 0x00000010, + + tdClassSemanticsMask = 0x00000020, + tdClass = 0x00000000, + tdInterface = 0x00000020, + + tdAbstract = 0x00000080, + tdSealed = 0x00000100, + tdSpecialName = 0x00000400, + + tdImport = 0x00001000, + tdSerializable = 0x00002000, + tdWindowsRuntime = 0x00004000, + + tdStringFormatMask = 0x00030000, + tdAnsiClass = 0x00000000, + tdUnicodeClass = 0x00010000, + tdAutoClass = 0x00020000, + tdCustomFormatClass = 0x00030000, + tdCustomFormatMask = 0x00C00000, + + tdBeforeFieldInit = 0x00100000, + tdForwarder = 0x00200000, + + tdReservedMask = 0x00040800, + tdRTSpecialName = 0x00000800, + tdHasSecurity = 0x00040000, + +} CorTypeAttr; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`tdVisibilityMask`|Used for type visibility information.| +|`tdNotPublic`|Specifies that the type is not in public scope.| +|`tdPublic`|Specifies that the type is in public scope.| +|`tdNestedPublic`|Specifies that the type is nested with public visibility.| +|`tdNestedPrivate`|Specifies that the type is nested with private visibility.| +|`tdNestedFamily`|Specifies that the type is nested with family visibility.| +|`tdNestedAssembly`|Specifies that the type is nested with assembly visibility.| +|`tdNestedFamANDAssem`|Specifies that the type is nested with family and assembly visibility.| +|`tdNestedFamORAssem`|Specifies that the type is nested with family or assembly visibility.| +|`tdLayoutMask`|Gets layout information for the type.| +|`tdAutoLayout`|Specifies that the fields of this type are laid out automatically.| +|`tdSequentialLayout`|Specifies that the fields of this type are laid out sequentially.| +|`tdExplicitLayout`|Specifies that field layout is supplied explicitly.| +|`tdClassSemanticsMask`|Gets semantic information about the type.| +|`tdClass`|Specifies that the type is a class.| +|`tdInterface`|Specifies that the type is an interface.| +|`tdAbstract`|Specifies that the type is abstract.| +|`tdSealed`|Specifies that the type cannot be extended.| +|`tdSpecialName`|Specifies that the class name is special. Its name describes how.| +|`tdImport`|Specifies that the type is imported.| +|`tdSerializable`|Specifies that the type is serializable.| +|`tdWindowsRuntime`|Specifies that this type is a Windows Runtime type.| +|`tdStringFormatMask`|Gets information about how strings are encoded and formatted.| +|`tdAnsiClass`|Specifies that this type interprets an LPTSTR as ANSI.| +|`tdUnicodeClass`|Specifies that this type interprets an LPTSTR as Unicode.| +|`tdAutoClass`|Specifies that this type interprets an LPTSTR automatically.| +|`tdCustomFormatClass`|Specifies that the type has a non-standard encoding, as specified by `CustomFormatMask`.| +|`tdCustomFormatMask`|Use this mask to get non-standard encoding information for native interop. The meaning of the values of these two bits is unspecified.| +|`tdBeforeFieldInit`|Specifies that the type must be initialized before the first attempt to access a static field.| +|`tdForwarder`|Specifies that the type is exported, and a type forwarder.| +|`tdReservedMask`|This flag and the flags below are used internally by the common language runtime.| +|`tdRTSpecialName`|Specifies that the common language runtime should check the name encoding.| +|`tdHasSecurity`|Specifies that the type has security associated with it.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md new file mode 100644 index 0000000000000..17e53431fe3c3 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md @@ -0,0 +1,67 @@ +--- +description: "Learn more about: CorUnmanagedCallingConvention Enumeration" +title: "CorUnmanagedCallingConvention Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorUnmanagedCallingConvention" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorUnmanagedCallingConvention" +helpviewer_keywords: + - "CorUnmanagedCallingConvention enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorUnmanagedCallingConvention Enumeration + +Specifies the calling conventions for unmanaged code. + +## Syntax + +```cpp +typedef enum CorUnmanagedCallingConvention { + + IMAGE_CEE_UNMANAGED_CALLCONV_C = 0x1, + IMAGE_CEE_UNMANAGED_CALLCONV_STDCALL = 0x2, + IMAGE_CEE_UNMANAGED_CALLCONV_THISCALL = 0x3, + IMAGE_CEE_UNMANAGED_CALLCONV_FASTCALL = 0x4, + + IMAGE_CEE_CS_CALLCONV_C = 0x1, + IMAGE_CEE_CS_CALLCONV_STDCALL = 0x2, + IMAGE_CEE_CS_CALLCONV_THISCALL = 0x3, + IMAGE_CEE_CS_CALLCONV_FASTCALL = 0x4 + +} CorUnmanagedCallingConvention; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`IMAGE_CEE_UNMANAGED_CALLCONV_C`|The C language calling convention.| +|`IMAGE_CEE_UNMANAGED_CALLCONV_STDCALL`|The standard calling convention.| +|`IMAGE_CEE_UNMANAGED_CALLCONV_THISCALL`|The "this" calling convention.| +|`IMAGE_CEE_UNMANAGED_CALLCONV_FASTCALL`|The "fast" calling convention.| +|`IMAGE_CEE_CS_CALLCONV_C`|Not used.| +|`IMAGE_CEE_CS_CALLCONV_STDCALL`|Not used.| +|`IMAGE_CEE_CS_CALLCONV_THISCALL`|Not used.| +|`IMAGE_CEE_CS_CALLCONV_FASTCALL`|Not used.| + +## Remarks + + The CLR does not support the "fast" calling convention in .NET Framework version 1.0. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** CorHdr.h + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md new file mode 100644 index 0000000000000..2056d170ff14d --- /dev/null +++ b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md @@ -0,0 +1,61 @@ +--- +description: "Learn more about: CorValidatorModuleType Enumeration" +title: "CorValidatorModuleType Enumeration" +ms.date: "03/30/2017" +api_name: + - "CorValidatorModuleType" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorValidatorModuleType" +helpviewer_keywords: + - "CorValidatorModuleType enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CorValidatorModuleType Enumeration + +Specifies the type of a module. + +## Syntax + +```cpp +typedef enum +{ + ValidatorModuleTypeInvalid = 0x0, + ValidatorModuleTypeMin = 0x00000001, + ValidatorModuleTypePE = 0x00000001, + ValidatorModuleTypeObj = 0x00000002, + ValidatorModuleTypeEnc = 0x00000003, + ValidatorModuleTypeIncr = 0x00000004, + ValidatorModuleTypeMax = 0x00000004 +} CorValidatorModuleType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`ValidatorModuleTypeInvalid`|The module is an invalid type.| +|`ValidatorModuleTypeMin`|The minimum value of the `CorValidatorModuleType` enum.| +|`ValidatorModuleTypePE`|The module is a portable executable (PE) file.| +|`ValidatorModuleTypeObj`|The module is a .obj file.| +|`ValidatorModuleTypeEnc`|The module is an edit-and-continue debugger session.| +|`ValidatorModuleTypeIncr`|The module is one that has been incrementally built.| +|`ValidatorModuleTypeMax`|The maximum value of the `CorValidatorModuleType` enum.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md new file mode 100644 index 0000000000000..34f0c8203276f --- /dev/null +++ b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md @@ -0,0 +1,51 @@ +--- +description: "Learn more about: COUNINITIEE Enumeration" +title: "COUNINITIEE Enumeration" +ms.date: "03/30/2017" +api_name: + - "COUNINITIEE" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "COUNINITIEE" +helpviewer_keywords: + - "COUNINITIEE enumeration [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# COUNINITIEE Enumeration + +Specifies constants used by [CoUninitializeEE](../../../framework/unmanaged-api/hosting/couninitializeee-function.md) when initializing the common language runtime. + +## Syntax + +```cpp +typedef enum tagCOUNINITEE +{ + COUNINITEE_DEFAULT = 0x0, + COUNINITEE_DLL = 0x1 +} COUNINITIEE; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`COUNINITEE_DEFAULT`|Indicates default uninitialization mode.| +|`COUNINITEE_DLL`|Indicates uninitialization mode for unloading an assembly.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/cvstruct-structure.md b/docs/core/unmanaged-api/metadata/cvstruct-structure.md new file mode 100644 index 0000000000000..70f7b9e337d48 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/cvstruct-structure.md @@ -0,0 +1,54 @@ +--- +description: "Learn more about: CVStruct Structure" +title: "CVStruct Structure" +ms.date: "03/30/2017" +api_name: + - "CVStruct" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CVStruct" +helpviewer_keywords: + - "CVStruct structure [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# CVStruct Structure + +Contains information that is used when installing a module or a composite image. + +## Syntax + +```cpp +typedef struct { + short Major; + short Minor; + short Sub; + short Build; +} CVStruct; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|Major|Major version build number.| +|Minor|Minor version build number.| +|Sub|Sub-build number.| +|Build|Build number.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Structures](metadata-structures.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md new file mode 100644 index 0000000000000..d80064d8947f8 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md @@ -0,0 +1,62 @@ +--- +description: "Learn more about: ICeeGen::AddSectionReloc Method" +title: "ICeeGen::AddSectionReloc Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.AddSectionReloc" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::AddSectionReloc" +helpviewer_keywords: + - "AddSectionReloc method [.NET Framework metadata]" + - "ICeeGen::AddSectionReloc method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::AddSectionReloc Method + +Adds a .reloc instruction to the code base. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT AddSectionReloc ( + [in] HCEESECTION section, + [in] ULONG offset, + [in] HCEESECTION relativeTo, + [in] CeeSectionRelocType relocType +); +``` + +## Parameters + + `section` + [in] The section of in-memory code to which to add a .reloc instruction. + + `offset` + [in] The offset of the section. + + `relativeTo` + [in] The section to which `offset` refers. + + `relocType` + [in] One of the [CeeSectionRelocType](ceesectionreloctype-enumeration.md) values, indicating the kind of .reloc instruction to add. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md new file mode 100644 index 0000000000000..d6e3cd5539dc2 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: ICeeGen::AllocateMethodBuffer Method" +title: "ICeeGen::AllocateMethodBuffer Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.AllocateMethodBuffer" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::AllocateMethodBuffer" +helpviewer_keywords: + - "AllocateMethodBuffer method [.NET Framework metadata]" + - "ICeeGen::AllocateMethodBuffer method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::AllocateMethodBuffer Method + +Creates a buffer of the specified size for a method, and gets the relative virtual address of the method. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT AllocateMethodBuffer ( + [in] ULONG cchBuffer, + [out] UCHAR **lpBuffer, + [out] ULONG *RVA +); +``` + +## Parameters + + `cchBuffer` + [in] The length of the buffer to create. + + `lpBuffer` + [out] The returned buffer. + + `RVA` + [out] The relative virtual address of the method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md new file mode 100644 index 0000000000000..27ca9e21f874d --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: ICeeGen::ComputePointer Method" +title: "ICeeGen::ComputePointer Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.ComputePointer" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::ComputePointer" +helpviewer_keywords: + - "ICeeGen::ComputePointer method [.NET Framework metadata]" + - "ComputePointer method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::ComputePointer Method + +Determines the buffer for the specified code section. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT ComputePointer ( + [in] HCEESECTION section, + [in] ULONG RVA, + [out] UCHAR **lpBuffer +); +``` + +## Parameters + + `section` + [in] The code section for which to return a buffer. + + `RVA` + [in] The relative virtual address of the method for which to get a pointer. + + `lpBuffer` + [out] A pointer to the returned buffer. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md new file mode 100644 index 0000000000000..cf74ba8b951e8 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md @@ -0,0 +1,54 @@ +--- +description: "Learn more about: ICeeGen::EmitString Method" +title: "ICeeGen::EmitString Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.EmitString" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::EmitString" +helpviewer_keywords: + - "EmitString method [.NET Framework metadata]" + - "ICeeGen::EmitString method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::EmitString Method + +Emits the specified string into the code base. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT EmitString ( + [in] LPWSTR lpString, + [out] ULONG *RVA +); +``` + +## Parameters + + `lpString` + [in] The string to emit. + + `RVA` + [out] The relative virtual address of the emitted string. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md new file mode 100644 index 0000000000000..9a0adfa1a9c47 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md @@ -0,0 +1,47 @@ +--- +description: "Learn more about: ICeeGen::GenerateCeeFile Method" +title: "ICeeGen::GenerateCeeFile Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GenerateCeeFile" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GenerateCeeFile" +helpviewer_keywords: + - "GenerateCeeFile method [.NET Framework metadata]" + - "ICeeGen::GenerateCeeFile method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GenerateCeeFile Method + +Generates a code-base file that contains the code base currently loaded into this [ICeeGen](iceegen-interface.md) interface. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GenerateCeeFile (); +``` + +## Parameters + + `GenerateCeeFile` takes no parameters. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md new file mode 100644 index 0000000000000..cce2733394654 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md @@ -0,0 +1,50 @@ +--- +description: "Learn more about: ICeeGen::GenerateCeeMemoryImage Method" +title: "ICeeGen::GenerateCeeMemoryImage Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GenerateCeeMemoryImage" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GenerateCeeMemoryImage" +helpviewer_keywords: + - "ICeeGen::GenerateCeeMemoryImage method [.NET Framework metadata]" + - "GenerateCeeMemoryImage method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GenerateCeeMemoryImage Method + +Generates an image in memory for the code base. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GenerateCeeMemoryImage ( + [out] void **ppImage +); +``` + +## Parameters + + `ppImage` + [out] A pointer to the generated image. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md new file mode 100644 index 0000000000000..8b39595f51fb2 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md @@ -0,0 +1,50 @@ +--- +description: "Learn more about: ICeeGen::GetIlSection Method" +title: "ICeeGen::GetIlSection Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GetIlSection" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GetIlSection" +helpviewer_keywords: + - "GetIlSection method [.NET Framework metadata]" + - "ICeeGen::GetIlSection method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GetIlSection Method + +Gets the section of the intermediate language code base referenced by the specified handle. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GetIlSection ( + [in] HCEESECTION *section +); +``` + +## Parameters + + `section` + [in] The handle to the section to get. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md new file mode 100644 index 0000000000000..6e6276b079e40 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md @@ -0,0 +1,50 @@ +--- +description: "Learn more about: ICeeGen::GetIMapTokenIface Method" +title: "ICeeGen::GetIMapTokenIface Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GetIMapTokenIface" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GetIMapTokenIface" +helpviewer_keywords: + - "GetIMapTokenIface method [.NET Framework metadata]" + - "ICeeGen::GetIMapTokenIface method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GetIMapTokenIface Method + +Gets the interface referenced by the specified token. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GetIMapTokenIface ( + [in, out] IUnknown **pIMapToken +); +``` + +## Parameters + + `pIMapToken` + [in, out] The metadata token for the interface to be returned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md new file mode 100644 index 0000000000000..c2be5e17fc4dc --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md @@ -0,0 +1,54 @@ +--- +description: "Learn more about: ICeeGen::GetMethodBuffer Method" +title: "ICeeGen::GetMethodBuffer Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GetMethodBuffer" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GetMethodBuffer" +helpviewer_keywords: + - "ICeeGen::GetMethodBuffer method [.NET Framework metadata]" + - "GetMethodBuffer method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GetMethodBuffer Method + +Gets a buffer of the appropriate size for the method at the specified relative virtual address. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GetMethodBuffer ( + [in] ULONG RVA, + [out] UCHAR **lpBuffer +); +``` + +## Parameters + + `RVA` + [in] The relative virtual address of the method for which to return a buffer. + + `lpBuffer` + [out] A pointer to the returned buffer. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md new file mode 100644 index 0000000000000..626a4b193ccc4 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md @@ -0,0 +1,66 @@ +--- +description: "Learn more about: ICeeGen::GetSectionBlock Method" +title: "ICeeGen::GetSectionBlock Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GetSectionBlock" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GetSectionBlock" +helpviewer_keywords: + - "GetSectionBlock method [.NET Framework metadata]" + - "ICeeGen::GetSectionBlock method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GetSectionBlock Method + +Gets a section block of the code base. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GetSectionBlock ( + [in] HCEESECTION section, + [in] ULONG len, + [in] ULONG align = 1, + [out] void **ppBytes = 0 +); +``` + +## Parameters + + `section` + [in] The section from which to retrieve a block of the code base. + + `len` + [in] The length of the block to be retrieved. + + `align` + [in] The byte, relative to the beginning of the section, with which to align the first byte of the block. This is the position of the block within the section. + + `ppBytes` + [out] A pointer to a location that receives the address of the retrieved block. + +## Remarks + + Call `GetSectionBlock` only if you have special section requirements that are not handled by other methods. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md new file mode 100644 index 0000000000000..b5e95acc88a8d --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md @@ -0,0 +1,62 @@ +--- +description: "Learn more about: ICeeGen::GetSectionCreate Method" +title: "ICeeGen::GetSectionCreate Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GetSectionCreate" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GetSectionCreate" +helpviewer_keywords: + - "ICeeGen::GetSectionCreate method [.NET Framework metadata]" + - "GetSectionCreate method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GetSectionCreate Method + +Generates and gets a code section using the specified name and flag values. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GetSectionCreate ( + [in] const char *name, + [in] DWORD flags, + [out] HCEESECTION *section +); +``` + +## Parameters + + `name` + [in] A pointer to a string that specifies the name of the section to be created. + + `flags` + [in] Flags that specify options. + + `section` + [out] A pointer to the newly created code section. + +## Remarks + + Call `GetSectionCreate` only if you have special section requirements that are not handled by other methods. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md new file mode 100644 index 0000000000000..fe373692b5a1d --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: ICeeGen::GetSectionDataLen Method" +title: "ICeeGen::GetSectionDataLen Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GetSectionDataLen" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GetSectionDataLen" +helpviewer_keywords: + - "ICeeGen::GetSectionDataLen method [.NET Framework metadata]" + - "GetSectionDataLen method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GetSectionDataLen Method + +Gets the length of the specified section. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GetSectionDataLen ( + [in] HCEESECTION section, + [out] ULONG *dataLen +); +``` + +## Parameters + + `section` + [in] The data section whose length will be retrieved. + + `dataLen` + [out] The returned length of the specified section. + +## Remarks + + Call `GetSectionDataLen` only if you have special section requirements that are not handled by other methods. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md new file mode 100644 index 0000000000000..728f65a139636 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md @@ -0,0 +1,54 @@ +--- +description: "Learn more about: ICeeGen::GetString Method" +title: "ICeeGen::GetString Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GetString" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GetString" +helpviewer_keywords: + - "ICeeGen::GetString method [.NET Framework metadata]" + - "GetString method, ICeeGen interface [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GetString Method + +Gets the string stored at the specified relative virtual address. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GetString ( + [in] ULONG RVA, + [out] LPWSTR *lpString +); +``` + +## Parameters + + `RVA` + [in] The relative virtual address of the string to return. + + `lpString` + [out] The returned string. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md new file mode 100644 index 0000000000000..7bd2e6edd9506 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md @@ -0,0 +1,50 @@ +--- +description: "Learn more about: ICeeGen::GetStringSection Method" +title: "ICeeGen::GetStringSection Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.GetStringSection" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::GetStringSection" +helpviewer_keywords: + - "ICeeGen::GetStringSection method [.NET Framework metadata]" + - "GetStringSection method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::GetStringSection Method + +Gets a string representation of the code section referenced by the specified handle. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT GetStringSection ( + [in, out] HCEESECTION *section +); +``` + +## Parameters + + `section` + [in, out] The handle to the code section. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-interface.md b/docs/core/unmanaged-api/metadata/iceegen-interface.md similarity index 60% rename from docs/framework/unmanaged-api/metadata/iceegen-interface.md rename to docs/core/unmanaged-api/metadata/iceegen-interface.md index 9a57aea738a0f..4743026d12b92 100644 --- a/docs/framework/unmanaged-api/metadata/iceegen-interface.md +++ b/docs/core/unmanaged-api/metadata/iceegen-interface.md @@ -2,56 +2,55 @@ description: "Learn more about: ICeeGen Interface" title: "ICeeGen Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen" -helpviewer_keywords: +helpviewer_keywords: - "ICeeGen interface [.NET Framework metadata]" -ms.assetid: 383d20b0-efe9-4e71-8fb8-1186b2e7d0c0 -topic_type: +topic_type: - "apiref" --- # ICeeGen Interface -Provides methods for dynamic code compilation. - - This interface is obsolete and should not be used. - -## Methods - -|Method|Description| -|------------|-----------------| -|[AddSectionReloc Method](iceegen-addsectionreloc-method.md)|Obsolete. Adds a .reloc instruction to the code base.| -|[AllocateMethodBuffer Method](iceegen-allocatemethodbuffer-method.md)|Obsolete. Creates a buffer of the specified size for a method, and gets the relative virtual address of the method.| -|[ComputePointer Method](iceegen-computepointer-method.md)|Obsolete. Determines the buffer for the specified code section.| -|[EmitString Method](iceegen-emitstring-method.md)|Obsolete. Emits the specified string into the code base.| -|[GenerateCeeFile Method](iceegen-generateceefile-method.md)|Obsolete. Generates a code-base file that contains the code base currently loaded into this `ICeeGen`.| -|[GenerateCeeMemoryImage Method](iceegen-generateceememoryimage-method.md)|Obsolete. Generates an image in memory for the code base.| -|[GetIlSection Method](iceegen-getilsection-method.md)|Obsolete. Gets the section of the intermediate language code base referenced by the specified handle.| -|[GetIMapTokenIface Method](iceegen-getimaptokeniface-method.md)|Obsolete. Gets the interface referenced by the specified token.| -|[GetMethodBuffer Method](iceegen-getmethodbuffer-method.md)|Obsolete. Gets a buffer of the appropriate size for the method at the specified relative virtual address.| -|[GetSectionBlock Method](iceegen-getsectionblock-method.md)|Obsolete. Gets a section block of the code base.| -|[GetSectionCreate Method](iceegen-getsectioncreate-method.md)|Obsolete. Generates and gets a code section using the specified name and flag values.| -|[GetSectionDataLen Method](iceegen-getsectiondatalen-method.md)|Obsolete. Gets the length of the specified section.| -|[GetString Method](iceegen-getstring-method.md)|Obsolete. Gets the string stored at the specified relative virtual address.| -|[GetStringSection Method](iceegen-getstringsection-method.md)|Obsolete. Gets a string representation of the code section referenced by the specified handle.| -|[TruncateSection Method](iceegen-truncatesection-method.md)|Obsolete. Truncates the specified code section by the specified length.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides methods for dynamic code compilation. + + This interface is obsolete and should not be used. + +## Methods + +|Method|Description| +|------------|-----------------| +|[AddSectionReloc Method](iceegen-addsectionreloc-method.md)|Obsolete. Adds a .reloc instruction to the code base.| +|[AllocateMethodBuffer Method](iceegen-allocatemethodbuffer-method.md)|Obsolete. Creates a buffer of the specified size for a method, and gets the relative virtual address of the method.| +|[ComputePointer Method](iceegen-computepointer-method.md)|Obsolete. Determines the buffer for the specified code section.| +|[EmitString Method](iceegen-emitstring-method.md)|Obsolete. Emits the specified string into the code base.| +|[GenerateCeeFile Method](iceegen-generateceefile-method.md)|Obsolete. Generates a code-base file that contains the code base currently loaded into this `ICeeGen`.| +|[GenerateCeeMemoryImage Method](iceegen-generateceememoryimage-method.md)|Obsolete. Generates an image in memory for the code base.| +|[GetIlSection Method](iceegen-getilsection-method.md)|Obsolete. Gets the section of the intermediate language code base referenced by the specified handle.| +|[GetIMapTokenIface Method](iceegen-getimaptokeniface-method.md)|Obsolete. Gets the interface referenced by the specified token.| +|[GetMethodBuffer Method](iceegen-getmethodbuffer-method.md)|Obsolete. Gets a buffer of the appropriate size for the method at the specified relative virtual address.| +|[GetSectionBlock Method](iceegen-getsectionblock-method.md)|Obsolete. Gets a section block of the code base.| +|[GetSectionCreate Method](iceegen-getsectioncreate-method.md)|Obsolete. Generates and gets a code section using the specified name and flag values.| +|[GetSectionDataLen Method](iceegen-getsectiondatalen-method.md)|Obsolete. Gets the length of the specified section.| +|[GetString Method](iceegen-getstring-method.md)|Obsolete. Gets the string stored at the specified relative virtual address.| +|[GetStringSection Method](iceegen-getstringsection-method.md)|Obsolete. Gets a string representation of the code section referenced by the specified handle.| +|[TruncateSection Method](iceegen-truncatesection-method.md)|Obsolete. Truncates the specified code section by the specified length.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md new file mode 100644 index 0000000000000..94c99448c0aa3 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: ICeeGen::TruncateSection Method" +title: "ICeeGen::TruncateSection Method" +ms.date: "03/30/2017" +api_name: + - "ICeeGen.TruncateSection" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeGen::TruncateSection" +helpviewer_keywords: + - "TruncateSection method [.NET Framework metadata]" + - "ICeeGen::TruncateSection method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# ICeeGen::TruncateSection Method + +Truncates the specified code section by the specified length. + + This method is obsolete and should not be used. + +## Syntax + +```cpp +HRESULT TruncateSection ( + [in] HCEESECTION section, + [in] ULONG len +); +``` + +## Parameters + + `section` + [in] The section to truncate. + + `len` + [in] The length, in bytes, by which to truncate the section. + +## Remarks + + Call `TruncateSection` only if you have special section requirements that are not handled by other methods. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/core/unmanaged-api/metadata/ihostfilter-interface.md b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md new file mode 100644 index 0000000000000..04bef529970ff --- /dev/null +++ b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md @@ -0,0 +1,43 @@ +--- +description: "Learn more about: IHostFilter Interface" +title: "IHostFilter Interface" +ms.date: "03/30/2017" +api_name: + - "IHostFilter" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IHostFilter" +helpviewer_keywords: + - "IHostFilter interface [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IHostFilter Interface + +Provides a method to indicate that a specified token will be processed. + +> [!NOTE] +> The `IHostFilter` interface must be implemented by the client. + +## Methods + +|Method|Description| +|------------|-----------------| +|[MarkToken Method](ihostfilter-marktoken-method.md)|Indicates that the specified metadata token will be processed.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/metadata/ihostfilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/ihostfilter-marktoken-method.md rename to docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md index a4b5935aa33a4..46a79a8dc19c2 100644 --- a/docs/framework/unmanaged-api/metadata/ihostfilter-marktoken-method.md +++ b/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IHostFilter::MarkToken Method" title: "IHostFilter::MarkToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostFilter.MarkToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostFilter::MarkToken" -helpviewer_keywords: +helpviewer_keywords: - "MarkToken method, IHostFilter interface [.NET Framework metadata]" - "IHostFilter::MarkToken method [.NET Framework metadata]" -ms.assetid: d7061343-d0a3-4fd5-b312-61974f98bd62 -topic_type: +topic_type: - "apiref" --- # IHostFilter::MarkToken Method -Indicates that the specified metadata token will be processed. - -## Syntax - -```cpp -HRESULT MarkToken ( - [in] mdToken tk -); -``` - -## Parameters - - `tk` - [in] The metadata token to be processed. - -## Remarks - - Typically, you want a token to be processed if it is in the metadata scope. The `MarkToken` method is passed to the metadata engine via the [IMetaDataEmit::SetHandler](imetadataemit-sethandler-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Indicates that the specified metadata token will be processed. + +## Syntax + +```cpp +HRESULT MarkToken ( + [in] mdToken tk +); +``` + +## Parameters + + `tk` + [in] The metadata token to be processed. + +## Remarks + + Typically, you want a token to be processed if it is in the metadata scope. The `MarkToken` method is passed to the metadata engine via the [IMetaDataEmit::SetHandler](imetadataemit-sethandler-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imaptoken-interface.md b/docs/core/unmanaged-api/metadata/imaptoken-interface.md new file mode 100644 index 0000000000000..0cb48e7995994 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imaptoken-interface.md @@ -0,0 +1,43 @@ +--- +description: "Learn more about: IMapToken Interface" +title: "IMapToken Interface" +ms.date: "03/30/2017" +api_name: + - "IMapToken" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMapToken" +helpviewer_keywords: + - "IMapToken interface [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMapToken Interface + +Provides mapping capabilities between assemblies. + +> [!NOTE] +> The `IMapToken` interface must be implemented by the client. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Map Method](imaptoken-map-method.md)|Maps a relationship between two assemblies using metadata signatures.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/metadata/imaptoken-map-method.md b/docs/core/unmanaged-api/metadata/imaptoken-map-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imaptoken-map-method.md rename to docs/core/unmanaged-api/metadata/imaptoken-map-method.md index ff2ade05443d0..8f54925c6e42c 100644 --- a/docs/framework/unmanaged-api/metadata/imaptoken-map-method.md +++ b/docs/core/unmanaged-api/metadata/imaptoken-map-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMapToken::Map Method" title: "IMapToken::Map Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMapToken.Map" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMapToken::Map" -helpviewer_keywords: +helpviewer_keywords: - "IMapToken::Map method [.NET Framework metadata]" - "Map method [.NET Framework metadata]" -ms.assetid: b9b4bf2f-1098-43d6-9619-a99b4bda1940 -topic_type: +topic_type: - "apiref" --- # IMapToken::Map Method -Maps a relationship between the assemblies using metadata signatures. - -## Syntax - -```cpp -HRESULT Map ( +Maps a relationship between the assemblies using metadata signatures. + +## Syntax + +```cpp +HRESULT Map ( [in] mdToken tkImp, - [in] mdToken tkEmit -); -``` - -## Parameters - - `tkImp` - [in] The metadata token that represents the imported code object. - - `tkEmit` - [in] The metadata token that represents the emitted code object. - -## Remarks - - When the token re-map occurs during a merge, the original token is scoped in the imported (source) metadata scope and the new token is scoped in the emitted (target) metadata scope. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] mdToken tkEmit +); +``` + +## Parameters + + `tkImp` + [in] The metadata token that represents the imported code object. + + `tkEmit` + [in] The metadata token that represents the emitted code object. + +## Remarks + + When the token re-map occurs during a merge, the original token is scoped in the imported (source) metadata scope and the new token is scoped in the emitted (target) metadata scope. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMapToken Interface](imaptoken-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md new file mode 100644 index 0000000000000..73b5ff24768e0 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md @@ -0,0 +1,76 @@ +--- +description: "Learn more about: IMetaDataAssemblyEmit::DefineAssembly Method" +title: "IMetaDataAssemblyEmit::DefineAssembly Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataAssemblyEmit.DefineAssembly" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataAssemblyEmit::DefineAssembly" +helpviewer_keywords: + - "IMetaDataAssemblyEmit::DefineAssembly method [.NET Framework metadata]" + - "DefineAssembly method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataAssemblyEmit::DefineAssembly Method + +Creates an `Assembly` structure containing metadata for the specified assembly and returns the associated metadata token. + +## Syntax + +```cpp +HRESULT DefineAssembly ( + [in] void *pbPublicKey, + [in] ULONG cbPublicKey, + [in] ULONG uHashAlgId, + [in] LPCWSTR szName, + [in] ASSEMBLYMETADATA *pMetaData, + [in] DWORD dwAssemblyFlags, + [out] mdAssembly *pmda +); +``` + +## Parameters + + `pbPublicKey` + [in] The public key that identifies the publisher of the assembly, or NULL if the assembly is not strongly named. + + `cbPublicKey` + [in] The size in bytes of `pbPublicKey`. + + `uHashAlgId` + [in] The identifier of the hashing algorithm to use to encrypt the files in the assembly, or NULL to specify the SHA-1 algorithm. + + `szName` + [in] The human-readable text name of the assembly. This value must not exceed 1024 characters. + + `pMetaData` + [in] A pointer to an [ASSEMBLYMETADATA](assemblymetadata-structure.md) instance that contains the version, platform, and locale information for the assembly. + + `dwAssemblyFlags` + [in] A combination of [CorAssemblyFlags](corassemblyflags-enumeration.md) values that describe features of the assembly. + + `pmda` + [out] A pointer to the metadata token. + +## Remarks + + Only one `Assembly` metadata structure can be defined within a manifest. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md new file mode 100644 index 0000000000000..912315bcf1ad3 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md @@ -0,0 +1,82 @@ +--- +description: "Learn more about: IMetaDataAssemblyEmit::DefineAssemblyRef Method" +title: "IMetaDataAssemblyEmit::DefineAssemblyRef Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataAssemblyEmit.DefineAssemblyRef" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataAssemblyEmit::DefineAssemblyRef" +helpviewer_keywords: + - "DefineAssemblyRef method [.NET Framework metadata]" + - "IMetaDataAssemblyEmit::DefineAssemblyRef method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataAssemblyEmit::DefineAssemblyRef Method + +Creates an `AssemblyRef` structure containing metadata for the assembly that this assembly references, and returns the associated metadata token. + +## Syntax + +```cpp +HRESULT DefineAssemblyRef ( + [in] void *pbPublicKeyOrToken, + [in] ULONG cbPublicKeyOrToken, + [in] LPCWSTR szName, + [in] ASSEMBLYMETADATA pMetaData, + [in] void *pbHashValue, + [in] ULONG cbHashValue, + [in] DWORD dwAssemblyRefFlags, + [out] mdAssemblyRef *pmdar +); +``` + +## Parameters + + `pbPublicKeyOrToken` + [in] The public key of the publisher of the referenced assembly. The helper function [StrongNameTokenFromAssembly]((../../../framework/unmanaged-api/strong-naming/strongnametokenfromassembly-function.md) can be used to get the hash of the public key to pass as this parameter. + + `cbPublicKeyOrToken` + [in] The size in bytes of `pbPublicKeyOrToken`. + + `szName` + [in] The human-readable text name of the assembly. This value must not exceed 1024 characters. + + `pMetaData` + [in] An ASSEMBLYMETADATA instance that contains the version, platform and locale information of the referenced assembly. + + `pbHashValue` + [in] The hash data associated with the referenced assembly. Optional. + + `cbHashValue` + [in] The size in bytes of `pbHashValue`. + + `dwAssemblyRefFlags` + [in] A bitwise combination of [CorAssemblyFlags](corassemblyflags-enumeration.md) values that influence the behavior of the execution engine. + + `pmdar` + [out] A pointer to the returned `AssemblyRef` metadata token. + +## Remarks + + One `AssemblyRef` metadata structure must be defined for each assembly that this assembly references. + + At run time, the details of a referenced assembly are passed to the assembly resolver with an indication that they represent the "as built" information. The assembly resolver then applies policy. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md similarity index 58% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md index f46a48cc58f66..2d4f894f6de6c 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md @@ -2,76 +2,75 @@ description: "Learn more about: IMetaDataAssemblyEmit::DefineExportedType Method" title: "IMetaDataAssemblyEmit::DefineExportedType Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.DefineExportedType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::DefineExportedType" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyEmit::DefineExportedType method [.NET Framework metadata]" - "DefineExportedType method [.NET Framework metadata]" -ms.assetid: fad01d7a-3178-4c8c-9f0a-4641e3701c9b -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyEmit::DefineExportedType Method -Creates an `ExportedType` structure containing metadata for the specified exported type, and returns the associated metadata token. - -## Syntax - -```cpp -HRESULT DefineExportedType ( - [in] LPCWSTR szName, +Creates an `ExportedType` structure containing metadata for the specified exported type, and returns the associated metadata token. + +## Syntax + +```cpp +HRESULT DefineExportedType ( + [in] LPCWSTR szName, [in] mdToken tkImplementation, - [in] mdTypeDef tkTypeDef, - [in] DWORD dwExportedTypeFlags, - [out] mdExportedType *pmdct -); -``` - -## Parameters - - `szName` - [in] The name of type to be exported. For version 1.1 of the common language runtime, the name of the exported type must exactly match the name given in the `TypeDef` for the type. - - `tkImplementation` - [in] A token specifying where the exported type is implemented. The valid values and their associated meanings are: - -- `mdFile` The type is implemented in a different file within this assembly. - -- `mdAssemblyRef` The type is implemented in a different assembly. - -- `mdExportedTYpe` The type is nested within some other type. - -- `mdFileNil` The type is in the same file as the manifest and is not a nested type. - - `tkTypeDef` - [in] A token to the metadata that specifies the type to be exported. This value is entered in the `TypeDef` table in the file that implements the type and is relevant only if that file is in this assembly. - - `dwExportedTypeFlags` - [in] A bitwise combination of [CorTypeAttr](cortypeattr-enumeration.md) enumeration values that define the property settings for the exported type. - - `pmdct` - [out] A pointer to the returned metadata token that indicates the exported type. - -## Remarks - - An `ExportedType` metadata structure must be defined for each type that is exposed by this assembly and that is implemented in a module other than the one containing the manifest. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] mdTypeDef tkTypeDef, + [in] DWORD dwExportedTypeFlags, + [out] mdExportedType *pmdct +); +``` + +## Parameters + + `szName` + [in] The name of type to be exported. For version 1.1 of the common language runtime, the name of the exported type must exactly match the name given in the `TypeDef` for the type. + + `tkImplementation` + [in] A token specifying where the exported type is implemented. The valid values and their associated meanings are: + +- `mdFile` The type is implemented in a different file within this assembly. + +- `mdAssemblyRef` The type is implemented in a different assembly. + +- `mdExportedTYpe` The type is nested within some other type. + +- `mdFileNil` The type is in the same file as the manifest and is not a nested type. + + `tkTypeDef` + [in] A token to the metadata that specifies the type to be exported. This value is entered in the `TypeDef` table in the file that implements the type and is relevant only if that file is in this assembly. + + `dwExportedTypeFlags` + [in] A bitwise combination of [CorTypeAttr](cortypeattr-enumeration.md) enumeration values that define the property settings for the exported type. + + `pmdct` + [out] A pointer to the returned metadata token that indicates the exported type. + +## Remarks + + An `ExportedType` metadata structure must be defined for each type that is exposed by this assembly and that is implemented in a module other than the one containing the manifest. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md new file mode 100644 index 0000000000000..ad6392945e643 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md @@ -0,0 +1,68 @@ +--- +description: "Learn more about: IMetaDataAssemblyEmit::DefineFile Method" +title: "IMetaDataAssemblyEmit::DefineFile Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataAssemblyEmit.DefineFile" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataAssemblyEmit::DefineFile" +helpviewer_keywords: + - "IMetaDataAssemblyEmit::DefineFile method [.NET Framework metadata]" + - "DefineFile method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataAssemblyEmit::DefineFile Method + +Creates a `File` metadata structure containing metadata for assembly referenced by this assembly, and returns the associated metadata token. + +## Syntax + +```cpp +HRESULT DefineFile ( + [in] LPCWSTR szName, + [in] const void *pbHashValue, + [in] ULONG cbHashValue, + [in] DWORD dwFileFlags, + [out] mdFile *pmdf +); +``` + +## Parameters + + `szName` + [in] The name of the file to be consumed. + + `pbHashValue` + [in] A pointer to the hash data associated with the assembly. + + `cbHashValue` + [in] The size in bytes of `pbHashValue`. + + `dwFileFlags` + [in] A bitwise combination of `FileFlags` values that specify property settings. + + `pmdf` + [out] A pointer to the returned `File` token. + +## Remarks + + One `File` metadata structure must be defined for each file that was part of this assembly at the time that this assembly was built, excluding the file that contains the metadata. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md similarity index 62% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md index b0473310d809c..c06835847e1f3 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IMetaDataAssemblyEmit::DefineManifestResource Method" title: "IMetaDataAssemblyEmit::DefineManifestResource Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.DefineManifestResource" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::DefineManifestResource" -helpviewer_keywords: +helpviewer_keywords: - "DefineManifestResource method [.NET Framework metadata]" - "IMetaDataAssemblyEmit::DefineManifestResource method [.NET Framework metadata]" -ms.assetid: 27f6d295-0fe9-4cda-b77e-6e7d5c53df09 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyEmit::DefineManifestResource Method -Creates a `ManifestResource` structure containing metadata for the specified manifest resource, and returns the associated metadata token. - -## Syntax - -```cpp -HRESULT DefineManifestResource ( +Creates a `ManifestResource` structure containing metadata for the specified manifest resource, and returns the associated metadata token. + +## Syntax + +```cpp +HRESULT DefineManifestResource ( [in] LPCWSTR szName, [in] mdToken tkImplementation, [in] DWORD dwOffset, - [in] DWORD dwResourceFlags, - [out] mdManifestResource *pmdmr -); -``` - -## Parameters - - `szName` - [in] The name of the resource. - - `tkImplementation` - [in] A metadata token of type `mdtFile` or `mdtAssemblyRef` that maps to the resource provider. A NULL value indicates that the file in which the metadata is embedded is the resource provider. - - `dwOffset` - [in] The offset to the beginning of the resource within the file. For resources in standalone files, this will always be zero. If the resource is embedded in a PE (portable executable) file, this is an offset of the resource BLOB, which starts at the location specified in the cor.h header file. - - `dwResourceFlags` - [in] A bitwise combination of flag values that specify property settings for the resource definition. - - `pmdmr` - [out] A pointer to the returned metadata token. - -## Remarks - - One `ManifestResource` metadata structure must be defined for each resource that is implemented in each of the assembly's files. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] DWORD dwResourceFlags, + [out] mdManifestResource *pmdmr +); +``` + +## Parameters + + `szName` + [in] The name of the resource. + + `tkImplementation` + [in] A metadata token of type `mdtFile` or `mdtAssemblyRef` that maps to the resource provider. A NULL value indicates that the file in which the metadata is embedded is the resource provider. + + `dwOffset` + [in] The offset to the beginning of the resource within the file. For resources in standalone files, this will always be zero. If the resource is embedded in a PE (portable executable) file, this is an offset of the resource BLOB, which starts at the location specified in the cor.h header file. + + `dwResourceFlags` + [in] A bitwise combination of flag values that specify property settings for the resource definition. + + `pmdmr` + [out] A pointer to the returned metadata token. + +## Remarks + + One `ManifestResource` metadata structure must be defined for each resource that is implemented in each of the assembly's files. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md similarity index 70% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-interface.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md index 506031f5eba66..0d48f1322b826 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md @@ -2,51 +2,50 @@ description: "Learn more about: IMetaDataAssemblyEmit Interface" title: "IMetaDataAssemblyEmit Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyEmit interface [.NET Framework metadata]" -ms.assetid: 34fb03cc-2285-4a45-ac48-ad993b7a921a -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyEmit Interface -Provides methods that support the self-description model used by the common language runtime to resolve and consume resources. - -## Methods - -|Method|Description| -|------------|-----------------| -|[DefineAssembly Method](imetadataassemblyemit-defineassembly-method.md)|Creates an assembly data structure containing metadata for the specified assembly, and returns the associated metadata token.| -|[DefineAssemblyRef Method](imetadataassemblyemit-defineassemblyref-method.md)|Creates an `AssemblyRef` structure containing metadata for the assembly that this assembly references, and returns the associated metadata token.| -|[DefineExportedType Method](imetadataassemblyemit-defineexportedtype-method.md)|Creates an `ExportedType` structure containing metadata for the specified exported type, and returns the associated metadata token.| -|[DefineFile Method](imetadataassemblyemit-definefile-method.md)|Creates a `File` metadata structure containing metadata for assembly referenced by this assembly, and returns the associated metadata token.| -|[DefineManifestResource Method](imetadataassemblyemit-definemanifestresource-method.md)|Creates a `ManifestResource` structure containing metadata for the specified manifest resource, and returns the associated metadata token.| -|[SetAssemblyProps Method](imetadataassemblyemit-setassemblyprops-method.md)|Modifies the specified `Assembly` metadata structure.| -|[SetAssemblyRefProps Method](imetadataassemblyemit-setassemblyrefprops-method.md)|Modifies the specified `AssemblyRef` metadata structure.| -|[SetExportedTypeProps Method](imetadataassemblyemit-setexportedtypeprops-method.md)|Modifies the specified `ExportedType` metadata structure.| -|[SetFileProps Method](imetadataassemblyemit-setfileprops-method.md)|Modifies the specified `File` metadata structure.| -|[SetManifestResourceProps Method](imetadataassemblyemit-setmanifestresourceprops-method.md)|Modifies the specified `ManifestResource` metadata structure.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides methods that support the self-description model used by the common language runtime to resolve and consume resources. + +## Methods + +|Method|Description| +|------------|-----------------| +|[DefineAssembly Method](imetadataassemblyemit-defineassembly-method.md)|Creates an assembly data structure containing metadata for the specified assembly, and returns the associated metadata token.| +|[DefineAssemblyRef Method](imetadataassemblyemit-defineassemblyref-method.md)|Creates an `AssemblyRef` structure containing metadata for the assembly that this assembly references, and returns the associated metadata token.| +|[DefineExportedType Method](imetadataassemblyemit-defineexportedtype-method.md)|Creates an `ExportedType` structure containing metadata for the specified exported type, and returns the associated metadata token.| +|[DefineFile Method](imetadataassemblyemit-definefile-method.md)|Creates a `File` metadata structure containing metadata for assembly referenced by this assembly, and returns the associated metadata token.| +|[DefineManifestResource Method](imetadataassemblyemit-definemanifestresource-method.md)|Creates a `ManifestResource` structure containing metadata for the specified manifest resource, and returns the associated metadata token.| +|[SetAssemblyProps Method](imetadataassemblyemit-setassemblyprops-method.md)|Modifies the specified `Assembly` metadata structure.| +|[SetAssemblyRefProps Method](imetadataassemblyemit-setassemblyrefprops-method.md)|Modifies the specified `AssemblyRef` metadata structure.| +|[SetExportedTypeProps Method](imetadataassemblyemit-setexportedtypeprops-method.md)|Modifies the specified `ExportedType` metadata structure.| +|[SetFileProps Method](imetadataassemblyemit-setfileprops-method.md)|Modifies the specified `File` metadata structure.| +|[SetManifestResourceProps Method](imetadataassemblyemit-setmanifestresourceprops-method.md)|Modifies the specified `ManifestResource` metadata structure.| + +## Remarks + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md new file mode 100644 index 0000000000000..ef244eb65111a --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md @@ -0,0 +1,76 @@ +--- +description: "Learn more about: IMetaDataAssemblyEmit::SetAssemblyProps Method" +title: "IMetaDataAssemblyEmit::SetAssemblyProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataAssemblyEmit.SetAssemblyProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataAssemblyEmit::SetAssemblyProps" +helpviewer_keywords: + - "SetAssemblyProps method [.NET Framework metadata]" + - "IMetaDataAssemblyEmit::SetAssemblyProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataAssemblyEmit::SetAssemblyProps Method + +Modifies the specified `Assembly` metadata structure. + +## Syntax + +```cpp +HRESULT SetAssemblyProps ( + [in] mdAssembly pma, + [in] const void *pbPublicKey, + [in] ULONG cbPublicKey, + [in] ULONG ulHashAlgId, + [in] LPCWSTR szName, + [in] const ASSEMBLYMETADATA *pMetaData, + [in] DWORD dwAssemblyFlags +); +``` + +## Parameters + + `pma` + [in] The metadata token that specifies the `Assembly` metadata structure to be modified. + + `pbPublicKey` + [in] A pointer to the public key of the publisher of the assembly. + + `cbPublicKey` + [in] The size in bytes of `pbPublicKey`. + + `ulHashAlgId` + [in] The identifier for the hash algorithm used to hash the assembly files. + + `szName` + [in] The human-readable text name of the assembly. + + `pMetaData` + [in] A pointer to the ASSEMBLYMETADATA that contains version, platform, and locale information for the assembly. + + `dwAssemblyFlags` + [in] A bitwise combination of [AssemblyFlags](assemblyflags-enumeration.md) values that specify various attributes of the assembly. + +## Remarks + + To create an `Assembly` metadata structure, use the [IMetaDataAssemblyEmit::DefineAssembly](imetadataassemblyemit-defineassembly-method.md) method. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md new file mode 100644 index 0000000000000..fa33d1556c1bb --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md @@ -0,0 +1,80 @@ +--- +description: "Learn more about: IMetaDataAssemblyEmit::SetAssemblyRefProps Method" +title: "IMetaDataAssemblyEmit::SetAssemblyRefProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataAssemblyEmit.SetAssemblyRefProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataAssemblyEmit::SetAssemblyRefProps" +helpviewer_keywords: + - "SetAssemblyRefProps method [.NET Framework metadata]" + - "IMetaDataAssemblyEmit::SetAssemblyRefProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataAssemblyEmit::SetAssemblyRefProps Method + +Modifies the specified `AssemblyRef` metadata structure. + +## Syntax + +```cpp +HRESULT SetAssemblyRefProps ( + [in] mdAssemblyRef ar, + [in] const void *pbPublicKeyOrToken, + [in] ULONG cbPublicKeyOrToken, + [in] LPCWSTR szName, + [in] const ASSEMBLYMETADATA *pMetaData, + [in] const void *pbHashValue, + [in] ULONG cbHashValue, + [in] DWORD dwAssemblyRefFlags +); +``` + +## Parameters + + `ar` + [in] The metadata token that specifies the `AssemblyRef` metadata structure to be modified. + + `pbPublicKeyOrToken` + [in] The public key of the publisher of the referenced assembly. + + `cbPublicKeyOrToken` + [in] The size in bytes of `pbPublicKeyOrToken`. + + `szName` + [in] The human-readable text name of the assembly. + + `pMetaData` + [in] A pointer to an ASSEMBLYMETADATA instance that contains the version, platform, and locale information for the assembly. + + `pbHashValue` + [in] A pointer to the hash data associated with the assembly. + + `cbHashValue` + [in] The size in bytes of `pbHashValue`. + + `dwAssemblyRefFlags` + [in] A bitwise combination of [AssemblyRefFlags](assemblyrefflags-enumeration.md) values that specify attributes of the referenced assembly. + +## Remarks + + To create an `AssemblyRef` metadata structure, use the [IMetaDataAssemblyEmit::DefineAssemblyRef](imetadataassemblyemit-defineassemblyref-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md new file mode 100644 index 0000000000000..57db5efa3ae63 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md @@ -0,0 +1,64 @@ +--- +description: "Learn more about: IMetaDataAssemblyEmit::SetExportedTypeProps Method" +title: "IMetaDataAssemblyEmit::SetExportedTypeProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataAssemblyEmit.SetExportedTypeProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataAssemblyEmit::SetExportedTypeProps" +helpviewer_keywords: + - "SetExportedTypeProps method [.NET Framework metadata]" + - "IMetaDataAssemblyEmit::SetExportedTypeProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataAssemblyEmit::SetExportedTypeProps Method + +Modifies the specified `ExportedType` metadata structure. + +## Syntax + +```cpp +HRESULT SetExportedTypeProps ( + [in] mdExportedType ct, + [in] mdToken tkImplementation, + [in] mdTypeDef tkTypeDef, + [in] DWORD dwExportedTypeFlags +); +``` + +## Parameters + + `ct` + [in] The metadata token that specifies the `ExportedType` metadata structure to be modified. + + `tkImplementation` + [in] The token, of type `File`, `AssemblyRef`, or `ExportedType`, that specifies how this type is implemented. + + `tkTypeDef` + [in] The `TypeDef` token referenced in the code file. + + `dwExportedTypeFlags` + [in] A bitwise combination of values that specify attributes of the type. + +## Remarks + + To create an `ExportedType` metadata structure, use the [IMetaDataAssemblyEmit::DefineExportedType](imetadataassemblyemit-defineexportedtype-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md new file mode 100644 index 0000000000000..5bff9e6408577 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md @@ -0,0 +1,64 @@ +--- +description: "Learn more about: IMetaDataAssemblyEmit::SetFileProps Method" +title: "IMetaDataAssemblyEmit::SetFileProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataAssemblyEmit.SetFileProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataAssemblyEmit::SetFileProps" +helpviewer_keywords: + - "IMetaDataAssemblyEmit::SetFileProps method [.NET Framework metadata]" + - "SetFileProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataAssemblyEmit::SetFileProps Method + +Modifies the specified `File` metadata structure. + +## Syntax + +```cpp +HRESULT SetFileProps ( + [in] mdFile file, + [in] const void *pbHashValue, + [in] ULONG cbHashValue, + [in] DWORD dwFileFlags +); +``` + +## Parameters + + `file` + [in] The metadata token that specifies the `File` metadata structure to be modified. + + `pbHashValue` + [in] A pointer to the hash data associated with the file. + + `cbHashValue` + [in] The size in bytes of `pbHashValue`. + + `dwFileFlags` + [in] A bitwise combination of [CorFileFlags](corfileflags-enumeration.md) values that specify various attributes of the file. + +## Remarks + + To create a `File` metadata structure, use the [IMetaDataAssemblyEmit::DefineFile](imetadataassemblyemit-definefile-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md index f8bd9278b43a9..3b4badee54d2f 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataAssemblyEmit::SetManifestResourceProps Method" title: "IMetaDataAssemblyEmit::SetManifestResourceProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.SetManifestResourceProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::SetManifestResourceProps" -helpviewer_keywords: +helpviewer_keywords: - "SetManifestResourceProps method [.NET Framework metadata]" - "IMetaDataAssemblyEmit::SetManifestResourceProps method [.NET Framework metadata]" -ms.assetid: ef77efd1-849c-4e51-ba92-7ee3d2bf0339 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyEmit::SetManifestResourceProps Method -Modifies the specified `ManifestResource` metadata structure. - -## Syntax - -```cpp -HRESULT SetManifestResourceProps ( - [in] mdManifestResource mr, +Modifies the specified `ManifestResource` metadata structure. + +## Syntax + +```cpp +HRESULT SetManifestResourceProps ( + [in] mdManifestResource mr, [in] mdToken tkImplementation, - [in] DWORD dwOffset, - [in] DWORD dwResourceFlags -); -``` - -## Parameters - - `mr` - [in] The token that specifies the `ManifestResource` metadata structure to be modified. - - `tkImplementation` - [in] The token, of type `File` or `AssemblyRef`, that maps to the resource provider. - - `dwOffset` - [in] The offset to the beginning of the resource within the file. - - `dwResourceFlags` - [in] A bitwise combination of flag values that specify the attributes of the resource. - -## Remarks - - To create a `ManifestResource` metadata structure, use the [IMetaDataAssemblyEmit::DefineManifestResource](imetadataassemblyemit-definemanifestresource-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] DWORD dwOffset, + [in] DWORD dwResourceFlags +); +``` + +## Parameters + + `mr` + [in] The token that specifies the `ManifestResource` metadata structure to be modified. + + `tkImplementation` + [in] The token, of type `File` or `AssemblyRef`, that maps to the resource provider. + + `dwOffset` + [in] The offset to the beginning of the resource within the file. + + `dwResourceFlags` + [in] A bitwise combination of flag values that specify the attributes of the resource. + +## Remarks + + To create a `ManifestResource` metadata structure, use the [IMetaDataAssemblyEmit::DefineManifestResource](imetadataassemblyemit-definemanifestresource-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md new file mode 100644 index 0000000000000..5ca28199ee0ed --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md @@ -0,0 +1,48 @@ +--- +description: "Learn more about: IMetaDataAssemblyImport::CloseEnum Method" +title: "IMetaDataAssemblyImport::CloseEnum Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataAssemblyImport.CloseEnum" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataAssemblyImport::CloseEnum" +helpviewer_keywords: + - "CloseEnum method, IMetaDataAssemblyImport interface [.NET Framework metadata]" + - "IMetaDataAssemblyImport::CloseEnum method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataAssemblyImport::CloseEnum Method + +Releases a reference to the specified enumeration instance. + +## Syntax + +```cpp +void CloseEnum ( + [in] HCORENUM hEnum +); +``` + +## Parameters + + `hEnum` + [in] The enumeration instance to be closed. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md index 5cefac1302e16..ce4bcb4fbd806 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IMetaDataAssemblyImport::EnumAssemblyRefs Method" title: "IMetaDataAssemblyImport::EnumAssemblyRefs Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.EnumAssemblyRefs" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::EnumAssemblyRefs" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyImport::EnumAssemblyRefs method [.NET Framework metadata]" - "EnumAssemblyRefs method [.NET Framework metadata]" -ms.assetid: 8844d0dd-730e-4592-8a7b-c1462d312c70 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::EnumAssemblyRefs Method -Enumerates the `mdAssemblyRef` instances that are defined in the assembly manifest. - -## Syntax - -```cpp -HRESULT EnumAssemblyRefs ( +Enumerates the `mdAssemblyRef` instances that are defined in the assembly manifest. + +## Syntax + +```cpp +HRESULT EnumAssemblyRefs ( [in, out] HCORENUM *phEnum, [out] mdAssemblyRef rAssemblyRefs[], [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be a null value when the `EnumAssemblyRefs` method is called for the first time. - - `rAssemblyRefs` - [out] The enumeration of `mdAssemblyRef` metadata tokens. - - `cMax` - [in] The maximum number of tokens that can be placed in the `rAssemblyRefs` array. - - `pcTokens` - [out] The number of tokens actually placed in `rAssemblyRefs`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumAssemblyRefs` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In this case, `pcTokens` is set to zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be a null value when the `EnumAssemblyRefs` method is called for the first time. + + `rAssemblyRefs` + [out] The enumeration of `mdAssemblyRef` metadata tokens. + + `cMax` + [in] The maximum number of tokens that can be placed in the `rAssemblyRefs` array. + + `pcTokens` + [out] The number of tokens actually placed in `rAssemblyRefs`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumAssemblyRefs` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In this case, `pcTokens` is set to zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md index c1cc80110ceff..e329f3c27881f 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IMetaDataAssemblyImport::EnumExportedTypes Method" title: "IMetaDataAssemblyImport::EnumExportedTypes Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.EnumExportedTypes" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::EnumExportedTypes" -helpviewer_keywords: +helpviewer_keywords: - "EnumExportedTypes method [.NET Framework metadata]" - "IMetaDataAssemblyImport::EnumExportedTypes method [.NET Framework metadata]" -ms.assetid: e5912ed8-e4ce-438b-8ea3-d9e4c288d109 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::EnumExportedTypes Method -Enumerates the exported types referenced in the assembly manifest in the current metadata scope. - -## Syntax - -```cpp -HRESULT EnumExportedTypes ( +Enumerates the exported types referenced in the assembly manifest in the current metadata scope. + +## Syntax + +```cpp +HRESULT EnumExportedTypes ( [in, out] HCORENUM *phEnum, [out] mdExportedType rExportedTypes[], [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be a null value when the `EnumExportedTypes` method is called for the first time. - - `rExportedTypes` - [out] The enumeration of `mdExportedType` metadata tokens. - - `cMax` - [in] The maximum number of `mdExportedType` tokens that can be placed in the `rExportedTypes` array. - - `pcTokens` - [out] The number of `mdExportedType` tokens actually placed in `rExportedTypes`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumExportedTypes` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In this case, `pcTokens` is set to zero.| - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be a null value when the `EnumExportedTypes` method is called for the first time. + + `rExportedTypes` + [out] The enumeration of `mdExportedType` metadata tokens. + + `cMax` + [in] The maximum number of `mdExportedType` tokens that can be placed in the `rExportedTypes` array. + + `pcTokens` + [out] The number of `mdExportedType` tokens actually placed in `rExportedTypes`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumExportedTypes` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In this case, `pcTokens` is set to zero.| + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md index 022b63045709f..af1af282d5b42 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IMetaDataAssemblyImport::EnumFiles Method" title: "IMetaDataAssemblyImport::EnumFiles Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.EnumFiles" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::EnumFiles" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyImport::EnumFiles method [.NET Framework metadata]" - "EnumFiles method [.NET Framework metadata]" -ms.assetid: f0d721e2-b946-426d-8e20-9124bd04e4cb -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::EnumFiles Method -Enumerates the files referenced in the current assembly manifest. - -## Syntax - -```cpp -HRESULT EnumFiles ( +Enumerates the files referenced in the current assembly manifest. + +## Syntax + +```cpp +HRESULT EnumFiles ( [in, out] HCORENUM *phEnum, [out] mdFile rFiles[], [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be a null value for the first call of this method. - - `rFiles` - [out] The array used to store the `mdFile` metadata tokens. - - `cMax` - [in] The maximum number of `mdFile` tokens that can be placed in `rFiles`. - - `pcTokens` - [out] The number of `mdFile` tokens actually placed in `rFiles`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumFiles` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In this case, `pcTokens` is set to zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be a null value for the first call of this method. + + `rFiles` + [out] The array used to store the `mdFile` metadata tokens. + + `cMax` + [in] The maximum number of `mdFile` tokens that can be placed in `rFiles`. + + `pcTokens` + [out] The number of `mdFile` tokens actually placed in `rFiles`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumFiles` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In this case, `pcTokens` is set to zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md similarity index 56% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md index 65dc2f77f2e77..24bb333dba202 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IMetaDataAssemblyImport::EnumManifestResources Method" title: "IMetaDataAssemblyImport::EnumManifestResources Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.EnumManifestResources" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::EnumManifestResources" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyImport::EnumManifestResources method [.NET Framework metadata]" - "EnumManifestResources method [.NET Framework metadata]" -ms.assetid: 9543b111-5705-40c9-935c-a3ffc7a581aa -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::EnumManifestResources Method -Gets a pointer to an enumerator for the resources referenced in the current assembly manifest. - -## Syntax - -```cpp -HRESULT EnumManifestResources ( +Gets a pointer to an enumerator for the resources referenced in the current assembly manifest. + +## Syntax + +```cpp +HRESULT EnumManifestResources ( [in, out] HCORENUM *phEnum, [out] mdManifestResource rManifestResources[], [in] ULONG cMax, - [out] ULONG *pcTokens + [out] ULONG *pcTokens ); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be a null value when the `EnumManifestResources` method is called for the first time. - - `rManifestResources` - [out] The array used to store the `mdManifestResource` metadata tokens. - - `cMax` - [in] The maximum number of `mdManifestResource` tokens that can be placed in `rManifestResources`. - - `pcTokens` - [out] The number of `mdManifestResource` tokens actually placed in `rManifestResources`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumManifestResources` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In this case, `pcTokens` is set to zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be a null value when the `EnumManifestResources` method is called for the first time. + + `rManifestResources` + [out] The array used to store the `mdManifestResource` metadata tokens. + + `cMax` + [in] The maximum number of `mdManifestResource` tokens that can be placed in `rManifestResources`. + + `pcTokens` + [out] The number of `mdManifestResource` tokens actually placed in `rManifestResources`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumManifestResources` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In this case, `pcTokens` is set to zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md index a3d814c0002c9..9cd5dedccc3e1 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md @@ -2,86 +2,85 @@ description: "Learn more about: IMetaDataAssemblyImport::FindAssembliesByName Method" title: "IMetaDataAssemblyImport::FindAssembliesByName Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.FindAssembliesByName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::FindAssembliesByName" -helpviewer_keywords: +helpviewer_keywords: - "FindAssembliesByName method [.NET Framework metadata]" - "IMetaDataAssemblyImport::FindAssembliesByName method [.NET Framework metadata]" -ms.assetid: 4db97cf9-e4c1-4233-8efa-cbdc0e14a8e4 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::FindAssembliesByName Method -Gets an array of assemblies with the specified `szAssemblyName` parameter, using the standard rules employed by the common language runtime (CLR) for resolving references. - -## Syntax - -```cpp -HRESULT FindAssembliesByName ( +Gets an array of assemblies with the specified `szAssemblyName` parameter, using the standard rules employed by the common language runtime (CLR) for resolving references. + +## Syntax + +```cpp +HRESULT FindAssembliesByName ( [in] LPCWSTR szAppBase, [in] LPCWSTR szPrivateBin, [in] LPCWSTR szAssemblyName, [out] IUnknown *ppIUnk[], [in] ULONG cMax, - [out] ULONG *pcAssemblies -); -``` - -## Parameters - - `szAppBase` - [in] The root directory in which to search for the given assembly. If this value is set to `null`, `FindAssembliesByName` will look only in the global assembly cache for the assembly. - - `szPrivateBin` - [in] A list of semicolon-delimited subdirectories (for example, "bin;bin2"), under the root directory, in which to search for the assembly. These directories are probed in addition to those specified in the default probing rules. - - `szAssemblyName` - [in] The name of the assembly to find. The format of this string is defined in the class reference page for . - - `ppIUnk` - [out] An array that holds the `IMetadataAssemblyImport` interface pointers. - - `cMax` - [in] The maximum number of interface pointers to place in `ppIUnk`. - - `pcAssemblies` - [out] The number of interface pointers returned—that is, the number of interface pointers actually placed in `ppIUnk`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`FindAssembliesByName` returned successfully.| -|`S_FALSE`|There are no assemblies.| - -## Remarks - - Given an assembly name, the `FindAssembliesByName` method finds the assembly by following the standard rules for resolving assembly references. (For more information, see [How the Runtime Locates Assemblies](../../deployment/how-the-runtime-locates-assemblies.md).) `FindAssembliesByName` allows the caller to configure various aspects of the assembly resolver context, such as application base and private search path. - - The `FindAssembliesByName` method requires the CLR to be initialized in the process in order to invoke the assembly resolution logic. Therefore, you must call [CoInitializeEE](../hosting/coinitializeee-function.md) (passing COINITEE_DEFAULT) before calling `FindAssembliesByName`, and then follow with a call to [CoUninitializeCor](../hosting/couninitializecor-function.md). - - `FindAssembliesByName` returns an [IMetaDataImport](imetadataimport-interface.md) pointer to the file containing the assembly manifest for the assembly name that is passed in. If the given assembly name is not fully specified (for example, if it does not include a version), multiple assemblies might be returned. - - `FindAssembliesByName` is commonly used by a compiler that attempts to find a referenced assembly at compile time. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] ULONG *pcAssemblies +); +``` + +## Parameters + + `szAppBase` + [in] The root directory in which to search for the given assembly. If this value is set to `null`, `FindAssembliesByName` will look only in the global assembly cache for the assembly. + + `szPrivateBin` + [in] A list of semicolon-delimited subdirectories (for example, "bin;bin2"), under the root directory, in which to search for the assembly. These directories are probed in addition to those specified in the default probing rules. + + `szAssemblyName` + [in] The name of the assembly to find. The format of this string is defined in the class reference page for . + + `ppIUnk` + [out] An array that holds the `IMetadataAssemblyImport` interface pointers. + + `cMax` + [in] The maximum number of interface pointers to place in `ppIUnk`. + + `pcAssemblies` + [out] The number of interface pointers returned—that is, the number of interface pointers actually placed in `ppIUnk`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`FindAssembliesByName` returned successfully.| +|`S_FALSE`|There are no assemblies.| + +## Remarks + + Given an assembly name, the `FindAssembliesByName` method finds the assembly by following the standard rules for resolving assembly references. (For more information, see [How the Runtime Locates Assemblies](../../../framework/deployment/how-the-runtime-locates-assemblies.md).) `FindAssembliesByName` allows the caller to configure various aspects of the assembly resolver context, such as application base and private search path. + + The `FindAssembliesByName` method requires the CLR to be initialized in the process in order to invoke the assembly resolution logic. Therefore, you must call [CoInitializeEE](../../../framework/unmanaged-api/hosting/coinitializeee-function.md) (passing COINITEE_DEFAULT) before calling `FindAssembliesByName`, and then follow with a call to [CoUninitializeCor](../../../framework/unmanaged-api/hosting/couninitializecor-function.md). + + `FindAssembliesByName` returns an [IMetaDataImport](imetadataimport-interface.md) pointer to the file containing the assembly manifest for the assembly name that is passed in. If the given assembly name is not fully specified (for example, if it does not include a version), multiple assemblies might be returned. + + `FindAssembliesByName` is commonly used by a compiler that attempts to find a referenced assembly at compile time. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also -- [How the Runtime Locates Assemblies](../../deployment/how-the-runtime-locates-assemblies.md) +- [How the Runtime Locates Assemblies](../../../framework/deployment/how-the-runtime-locates-assemblies.md) - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md index 78bd2b297d1fe..46712c3f5f0cc 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md @@ -2,61 +2,60 @@ description: "Learn more about: IMetaDataAssemblyImport::FindExportedTypeByName Method" title: "IMetaDataAssemblyImport::FindExportedTypeByName Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.FindExportedTypeByName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::FindExportedTypeByName" -helpviewer_keywords: +helpviewer_keywords: - "FindExportedTypeByName method [.NET Framework metadata]" - "IMetaDataAssemblyImport::FindExportedTypeByName method [.NET Framework metadata]" -ms.assetid: 46264b2c-574d-4dde-aafc-77187a104fdd -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::FindExportedTypeByName Method -Gets a pointer to an exported type, given its name and enclosing type. - -## Syntax - -```cpp -HRESULT FindExportedTypeByName ( +Gets a pointer to an exported type, given its name and enclosing type. + +## Syntax + +```cpp +HRESULT FindExportedTypeByName ( [in] LPCWSTR szName, [in] mdToken mdtExportedType, - [out] mdExportedType *ptkExportedType -); -``` - -## Parameters - - `szName` - [in] The name of the exported type. - - `mdtExportedType` - [in] The metadata token for the enclosing class of the exported type. This value is `mdExportedTypeNil` if the requested exported type is not a nested type. - - `ptkExportedType` - [out] A pointer to the `mdExportedType` token that represents the exported type. - -## Remarks - - The `FindExportedTypeByName` method uses the standard rules employed by the common language runtime for resolving references. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] mdExportedType *ptkExportedType +); +``` + +## Parameters + + `szName`\ + [in] The name of the exported type. + + `mdtExportedType`\ + [in] The metadata token for the enclosing class of the exported type. This value is `mdExportedTypeNil` if the requested exported type is not a nested type. + + `ptkExportedType`\ + [out] A pointer to the `mdExportedType` token that represents the exported type. + +## Remarks + + The `FindExportedTypeByName` method uses the standard rules employed by the common language runtime for resolving references. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) -- [How the Runtime Locates Assemblies](../../deployment/how-the-runtime-locates-assemblies.md) +- [How the Runtime Locates Assemblies](../../../framework/deployment/how-the-runtime-locates-assemblies.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md index c8670c0dd0a1d..fd24754a201c8 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md @@ -2,57 +2,56 @@ description: "Learn more about: IMetaDataAssemblyImport::FindManifestResourceByName Method" title: "IMetaDataAssemblyImport::FindManifestResourceByName Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.FindManifestResourceByName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::FindManifestResourceByName" -helpviewer_keywords: +helpviewer_keywords: - "FindManifestResourceByName method [.NET Framework metadata]" - "IMetaDataAssemblyImport::FindManifestResourceByName method [.NET Framework metadata]" -ms.assetid: 7b72fa11-3866-402b-bdea-2b966b77cfe0 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::FindManifestResourceByName Method -Gets a pointer to the manifest resource with the specified name. - -## Syntax - +Gets a pointer to the manifest resource with the specified name. + +## Syntax + ```cpp -HRESULT FindManifestResourceByName ( +HRESULT FindManifestResourceByName ( [in] LPCWSTR szName, - [out] mdManifestResource *ptkManifestResource + [out] mdManifestResource *ptkManifestResource ); -``` - -## Parameters - - `szName` - [in] The name of the resource. - - `ptkManifestResource` - [out] The array used to store the `mdManifestResource` metadata tokens, each of which represents a manifest resource. - -## Remarks - - The `FindManifestResourceByName` method uses the standard rules employed by the common language runtime for resolving references. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +``` + +## Parameters + + `szName` + [in] The name of the resource. + + `ptkManifestResource` + [out] The array used to store the `mdManifestResource` metadata tokens, each of which represents a manifest resource. + +## Remarks + + The `FindManifestResourceByName` method uses the standard rules employed by the common language runtime for resolving references. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) -- [How the Runtime Locates Assemblies](../../deployment/how-the-runtime-locates-assemblies.md) +- [How the Runtime Locates Assemblies](../../../framework/deployment/how-the-runtime-locates-assemblies.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md index d96dfb3d7d321..b8cda717d661b 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataAssemblyImport::GetAssemblyFromScope Method" title: "IMetaDataAssemblyImport::GetAssemblyFromScope Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.GetAssemblyFromScope" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::GetAssemblyFromScope" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyImport::GetAssemblyFromScope method [.NET Framework metadata]" - "GetAssemblyFromScope method [.NET Framework metadata]" -ms.assetid: 0b437f70-561d-48c7-abe0-0cb9ace10c08 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::GetAssemblyFromScope Method -Gets a pointer to the assembly in the current scope. - -## Syntax - -```cpp -HRESULT GetAssemblyFromScope ( - [out] mdAssembly *ptkAssembly -); -``` - -## Parameters - - `ptkAssembly` - [out] A pointer to the retrieved `mdAssembly` token that identifies the assembly. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a pointer to the assembly in the current scope. + +## Syntax + +```cpp +HRESULT GetAssemblyFromScope ( + [out] mdAssembly *ptkAssembly +); +``` + +## Parameters + + `ptkAssembly` + [out] A pointer to the retrieved `mdAssembly` token that identifies the assembly. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md new file mode 100644 index 0000000000000..a931b05764c6b --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md @@ -0,0 +1,80 @@ +--- +description: "Learn more about: IMetaDataAssemblyImport::GetAssemblyProps Method" +title: "IMetaDataAssemblyImport::GetAssemblyProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataAssemblyImport.GetAssemblyProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataAssemblyImport::GetAssemblyProps" +helpviewer_keywords: + - "GetAssemblyProps method [.NET Framework metadata]" + - "IMetaDataAssemblyImport::GetAssemblyProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataAssemblyImport::GetAssemblyProps Method + +Gets the set of properties for the assembly with the specified metadata signature. + +## Syntax + +```cpp +HRESULT GetAssemblyProps ( + [in] mdAssembly mda, + [out] const void **ppbPublicKey, + [out] ULONG *pcbPublicKey, + [out] ULONG *pulHashAlgId, + [out] LPWSTR szName, + [in] ULONG cchName, + [out] ULONG *pchName, + [out] ASSEMBLYMETADATA *pMetaData, + [out] DWORD *pdwAssemblyFlags +); +``` + +## Parameters + + `mda` + [in]. The `mdAssembly` metadata token that represents the assembly for which to get the properties. + + `ppbPublicKey` + [out] A pointer to the public key or the metadata token. + + `pcbPublicKey` + [out] The number of bytes in the returned public key. + + `pulHashAlgId` + [out] A pointer to the algorithm used to hash the files in the assembly. + + `szName` + [out] The simple name of the assembly. + + `cchName` + [in] The size, in wide chars, of `szName`. + + `pchName` + [out] The number of wide chars actually returned in `szName`. + + `pMetaData` + [out] A pointer to an ASSEMBLYMETADATA structure that contains the assembly metadata. + + `pdwAssemblyFlags` + [out] Flags that describe the metadata applied to an assembly. This value is a combination of one or more [CorAssemblyFlags](corassemblyflags-enumeration.md) values. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md index c254dec06a18e..0d8774d92aee6 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md @@ -2,29 +2,28 @@ description: "Learn more about: IMetaDataAssemblyImport::GetAssemblyRefProps Method" title: "IMetaDataAssemblyImport::GetAssemblyRefProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.GetAssemblyRefProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::GetAssemblyRefProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyImport::GetAssemblyRefProps method [.NET Framework metadata]" - "GetAssemblyRefProps method [.NET Framework metadata]" -ms.assetid: 5c6b7fb4-cbca-4479-b650-ab9a99732ea0 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::GetAssemblyRefProps Method -Gets the set of properties for the assembly reference with the specified metadata signature. - -## Syntax - -```cpp -HRESULT GetAssemblyRefProps ( +Gets the set of properties for the assembly reference with the specified metadata signature. + +## Syntax + +```cpp +HRESULT GetAssemblyRefProps ( [in] mdAssemblyRef mdar, [out] const void **ppbPublicKeyOrToken, [out] ULONG *pcbPublicKeyOrToken, @@ -34,56 +33,56 @@ HRESULT GetAssemblyRefProps ( [out] ASSEMBLYMETADATA *pMetaData, [out] const void **ppbHashValue, [out] ULONG *pcbHashValue, - [out] DWORD *pdwAssemblyRefFlags -); -``` - -## Parameters - - `mdar` - [in] The `mdAssemblyRef` metadata token that represents the assembly reference for which to get the properties. - - `ppbPublicKeyOrToken` - [out] A pointer to the public key or the metadata token. - - `pcbPublicKeyOrToken` - [out] The number of bytes in the returned public key or token. - - `szName` - [out] The simple name of the assembly. - - `cchName` - [in] The size, in wide chars, of `szName`. - - `pchName` - [out] A pointer to the number of wide chars actually returned in `szName`. - - `pMetaData` - [out] A pointer to an ASSEMBLYMETADATA structure that contains the assembly metadata. - - `ppbHashValue` - [out] A pointer to the hash value. This is the hash, using the SHA-1 algorithm, of the `PublicKey` property of the assembly being referenced, unless the arfFullOriginator flag of the [AssemblyRefFlags](assemblyrefflags-enumeration.md) enumeration is set. - - `pcbHashValue` - [out] The number of wide chars in the returned hash value. - - `pdwAssemblyRefFlags` - [out] A pointer to flags that describe the metadata applied to an assembly. The flags value is a combination of one or more [CorAssemblyFlags](corassemblyflags-enumeration.md) values. - -## Return Value - - This method returns S_OK if it succeeds; otherwise, it returns one of the error codes defined in the Winerror.h header file. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] DWORD *pdwAssemblyRefFlags +); +``` + +## Parameters + + `mdar` + [in] The `mdAssemblyRef` metadata token that represents the assembly reference for which to get the properties. + + `ppbPublicKeyOrToken` + [out] A pointer to the public key or the metadata token. + + `pcbPublicKeyOrToken` + [out] The number of bytes in the returned public key or token. + + `szName` + [out] The simple name of the assembly. + + `cchName` + [in] The size, in wide chars, of `szName`. + + `pchName` + [out] A pointer to the number of wide chars actually returned in `szName`. + + `pMetaData` + [out] A pointer to an ASSEMBLYMETADATA structure that contains the assembly metadata. + + `ppbHashValue` + [out] A pointer to the hash value. This is the hash, using the SHA-1 algorithm, of the `PublicKey` property of the assembly being referenced, unless the arfFullOriginator flag of the [AssemblyRefFlags](assemblyrefflags-enumeration.md) enumeration is set. + + `pcbHashValue` + [out] The number of wide chars in the returned hash value. + + `pdwAssemblyRefFlags` + [out] A pointer to flags that describe the metadata applied to an assembly. The flags value is a combination of one or more [CorAssemblyFlags](corassemblyflags-enumeration.md) values. + +## Return Value + + This method returns S_OK if it succeeds; otherwise, it returns one of the error codes defined in the Winerror.h header file. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md similarity index 59% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md index 98be4f4c1cba8..3d43a75f34dee 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataAssemblyImport::GetExportedTypeProps Method" title: "IMetaDataAssemblyImport::GetExportedTypeProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.GetExportedTypeProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::GetExportedTypeProps" -helpviewer_keywords: +helpviewer_keywords: - "GetExportedTypeProps method [.NET Framework metadata]" - "IMetaDataAssemblyImport::GetExportedTypeProps method [.NET Framework metadata]" -ms.assetid: 25ca7623-5a55-4f09-b44a-36b03d142278 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::GetExportedTypeProps Method -Gets the set of properties of the exported type with the specified metadata signature. - -## Syntax - -```cpp -HRESULT GetExportedTypeProps ( +Gets the set of properties of the exported type with the specified metadata signature. + +## Syntax + +```cpp +HRESULT GetExportedTypeProps ( [in] mdExportedType mdct, [out] LPWSTR szName, [in] ULONG cchName, [out] ULONG *pchName, [out] mdToken *ptkImplementation, [out] mdTypeDef *ptkTypeDef, - [out] DWORD *pdwExportedTypeFlags -); -``` - -## Parameters - - `mdct` - [in] An `mdExportedType` metadata token that represents the exported type. - - `szName` - [out] The name of the exported type. - - `cchName` - [in] The size, in wide characters, of `szName`. - - `pchName` - [out] The number of wide characters actually returned in `szName` - - `ptkImplementation` - [out] An `mdFile`, `mdAssemblyRef`, or `mdExportedType` metadata token that contains or allows access to the properties of the exported type. - - `ptkTypeDef` - [out] A pointer to an `mdTypeDef` token that represents a type in the file. - - `pdwExportedTypeFlags` - [out] A pointer to the flags that describe the metadata applied to the exported type. The flags value can be one or more [CorTypeAttr](cortypeattr-enumeration.md) values. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] DWORD *pdwExportedTypeFlags +); +``` + +## Parameters + + `mdct` + [in] An `mdExportedType` metadata token that represents the exported type. + + `szName` + [out] The name of the exported type. + + `cchName` + [in] The size, in wide characters, of `szName`. + + `pchName` + [out] The number of wide characters actually returned in `szName` + + `ptkImplementation` + [out] An `mdFile`, `mdAssemblyRef`, or `mdExportedType` metadata token that contains or allows access to the properties of the exported type. + + `ptkTypeDef` + [out] A pointer to an `mdTypeDef` token that represents a type in the file. + + `pdwExportedTypeFlags` + [out] A pointer to the flags that describe the metadata applied to the exported type. The flags value can be one or more [CorTypeAttr](cortypeattr-enumeration.md) values. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md index 134c85235090d..323921d027a42 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataAssemblyImport::GetFileProps Method" title: "IMetaDataAssemblyImport::GetFileProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.GetFileProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::GetFileProps" -helpviewer_keywords: +helpviewer_keywords: - "GetFileProps method [.NET Framework metadata]" - "IMetaDataAssemblyImport::GetFileProps method [.NET Framework metadata]" -ms.assetid: c5e6216f-ae3d-4697-9688-66b69c1251ec -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::GetFileProps Method -Gets the properties of the file with the specified metadata signature. - -## Syntax - -```cpp -HRESULT GetFileProps ( +Gets the properties of the file with the specified metadata signature. + +## Syntax + +```cpp +HRESULT GetFileProps ( [in] mdFile mdf, [out] LPWSTR szName, [in] ULONG cchName, [out] ULONG *pchName, [out] const void **ppbHashValue, [out] ULONG *pcbHashValue, - [out] DWORD *pdwFileFlags -); -``` - -## Parameters - - `mdf` - [in] The `mdFile` metadata token that represents the file for which to get the properties. - - `szName` - [out] The simple name of the file. - - `cchName` - [in] The size, in wide chars, of `szName`. - - `pchName` - [out] The number of wide chars actually returned in `szName`. - - `ppbHashValue` - [out] A pointer to the hash value. This is the hash, using the SHA-1 algorithm, of the file. - - `pcbHashValue` - [out] The number of wide chars in the returned hash value. - - `pdwFileFlags` - [out] A pointer to the flags that describe the metadata applied to a file. The flags value is a combination of one or more [CorFileFlags](corfileflags-enumeration.md) values. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] DWORD *pdwFileFlags +); +``` + +## Parameters + + `mdf` + [in] The `mdFile` metadata token that represents the file for which to get the properties. + + `szName` + [out] The simple name of the file. + + `cchName` + [in] The size, in wide chars, of `szName`. + + `pchName` + [out] The number of wide chars actually returned in `szName`. + + `ppbHashValue` + [out] A pointer to the hash value. This is the hash, using the SHA-1 algorithm, of the file. + + `pcbHashValue` + [out] The number of wide chars in the returned hash value. + + `pdwFileFlags` + [out] A pointer to the flags that describe the metadata applied to a file. The flags value is a combination of one or more [CorFileFlags](corfileflags-enumeration.md) values. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md similarity index 60% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md index b533d4bd3f578..6848aa23fde58 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataAssemblyImport::GetManifestResourceProps Method" title: "IMetaDataAssemblyImport::GetManifestResourceProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.GetManifestResourceProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::GetManifestResourceProps" -helpviewer_keywords: +helpviewer_keywords: - "GetManifestResourceProps method [.NET Framework metadata]" - "IMetaDataAssemblyImport::GetManifestResourceProps method [.NET Framework metadata]" -ms.assetid: 00be4789-ac63-4397-b2ec-1629a5c5a585 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport::GetManifestResourceProps Method -Gets the set of properties of the manifest resource with the specified metadata signature. - -## Syntax - -```cpp -HRESULT GetManifestResourceProps ( +Gets the set of properties of the manifest resource with the specified metadata signature. + +## Syntax + +```cpp +HRESULT GetManifestResourceProps ( [in] mdManifestResource mdmr, [out] LPWSTR szName, [in] ULONG cchName, [out] ULONG *pchName, [out] mdToken *ptkImplementation, [out] DWORD *pdwOffset, - [out] DWORD *pdwResourceFlags -); -``` - -## Parameters - - `mdmr` - [in] An `mdManifestResource` token that represents the resource for which to get the properties. - - `szName` - [out] The name of the resource. - - `cchName` - [in] The size, in wide chars, of `szName`. - - `pchName` - [out] A pointer to the number of wide chars actually returned in `szName`. - - `ptkImplementation` - [out] A pointer to an `mdFile` token or an `mdAssemblyRef` token that represents the file or assembly, respectively, that contains the resource. - - `pdwOffset` - [out] A pointer to a value that specifies the offset to the beginning of the resource within the file. - - `pdwResourceFlags` - [out] A pointer to flags that describe the metadata applied to a resource. The flags value is a combination of one or more [CorManifestResourceFlags](cormanifestresourceflags-enumeration.md) values. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] DWORD *pdwResourceFlags +); +``` + +## Parameters + + `mdmr` + [in] An `mdManifestResource` token that represents the resource for which to get the properties. + + `szName` + [out] The name of the resource. + + `cchName` + [in] The size, in wide chars, of `szName`. + + `pchName` + [out] A pointer to the number of wide chars actually returned in `szName`. + + `ptkImplementation` + [out] A pointer to an `mdFile` token or an `mdAssemblyRef` token that represents the file or assembly, respectively, that contains the resource. + + `pdwOffset` + [out] A pointer to a value that specifies the offset to the beginning of the resource within the file. + + `pdwResourceFlags` + [out] A pointer to flags that describe the metadata applied to a resource. The flags value is a combination of one or more [CorManifestResourceFlags](cormanifestresourceflags-enumeration.md) values. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md similarity index 70% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-interface.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md index 409fcc9df9841..5f4312800756f 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md @@ -2,53 +2,52 @@ description: "Learn more about: IMetaDataAssemblyImport Interface" title: "IMetaDataAssemblyImport Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyImport interface [.NET Framework metadata]" -ms.assetid: 29c6fba5-4cea-417d-b484-7ed22ebff1c9 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyImport Interface -Provides methods to access and examine the contents of an assembly manifest. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CloseEnum Method](imetadataassemblyimport-closeenum-method.md)|Releases the handle to the specified enumerator.| -|[EnumAssemblyRefs Method](imetadataassemblyimport-enumassemblyrefs-method.md)|Gets an interface pointer to an enumerator that contains the `mdAssemblyRef` tokens of the assemblies referenced by the assembly in the current metadata scope.| -|[EnumExportedTypes Method](imetadataassemblyimport-enumexportedtypes-method.md)|Gets an interface pointer to an enumerator that contains the `mdExportedType` tokens of the COM types referenced by the assembly in the current metadata scope.| -|[EnumFiles Method](imetadataassemblyimport-enumfiles-method.md)|Gets an interface pointer to an enumerator that contains the `mdFile` tokens of the files referenced by the assembly in the current metadata scope.| -|[EnumManifestResources Method](imetadataassemblyimport-enummanifestresources-method.md)|Gets an interface pointer to an enumerator that contains the `mdManifestResource` tokens of the resources referenced by the assembly in the current metadata scope.| -|[FindAssembliesByName Method](imetadataassemblyimport-findassembliesbyname-method.md)|Gets an array of `IMetaDataAssemblyImport` interface pointers for the assemblies with the specified name.| -|[FindExportedTypeByName Method](imetadataassemblyimport-findexportedtypebyname-method.md)|Gets an `mdExportedType` token for the COM type with the specified name.| -|[FindManifestResourceByName Method](imetadataassemblyimport-findmanifestresourcebyname-method.md)|Gets an `mdManifestResource` token for the resource with the specified name.| -|[GetAssemblyFromScope Method](imetadataassemblyimport-getassemblyfromscope-method.md)|Gets the token for the assembly in the current metadata scope.| -|[GetAssemblyProps Method](imetadataassemblyimport-getassemblyprops-method.md)|Gets the property settings of the specified assembly.| -|[GetAssemblyRefProps Method](imetadataassemblyimport-getassemblyrefprops-method.md)|Gets the property settings of the specified `mdAssemblyRef` token.| -|[GetExportedTypeProps Method](imetadataassemblyimport-getexportedtypeprops-method.md)|Gets the property settings of the specified COM type.| -|[GetFileProps Method](imetadataassemblyimport-getfileprops-method.md)|Gets the property settings of the specified file.| -|[GetManifestResourceProps Method](imetadataassemblyimport-getmanifestresourceprops-method.md)|Gets the property settings of the specified manifest resource.| - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides methods to access and examine the contents of an assembly manifest. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CloseEnum Method](imetadataassemblyimport-closeenum-method.md)|Releases the handle to the specified enumerator.| +|[EnumAssemblyRefs Method](imetadataassemblyimport-enumassemblyrefs-method.md)|Gets an interface pointer to an enumerator that contains the `mdAssemblyRef` tokens of the assemblies referenced by the assembly in the current metadata scope.| +|[EnumExportedTypes Method](imetadataassemblyimport-enumexportedtypes-method.md)|Gets an interface pointer to an enumerator that contains the `mdExportedType` tokens of the COM types referenced by the assembly in the current metadata scope.| +|[EnumFiles Method](imetadataassemblyimport-enumfiles-method.md)|Gets an interface pointer to an enumerator that contains the `mdFile` tokens of the files referenced by the assembly in the current metadata scope.| +|[EnumManifestResources Method](imetadataassemblyimport-enummanifestresources-method.md)|Gets an interface pointer to an enumerator that contains the `mdManifestResource` tokens of the resources referenced by the assembly in the current metadata scope.| +|[FindAssembliesByName Method](imetadataassemblyimport-findassembliesbyname-method.md)|Gets an array of `IMetaDataAssemblyImport` interface pointers for the assemblies with the specified name.| +|[FindExportedTypeByName Method](imetadataassemblyimport-findexportedtypebyname-method.md)|Gets an `mdExportedType` token for the COM type with the specified name.| +|[FindManifestResourceByName Method](imetadataassemblyimport-findmanifestresourcebyname-method.md)|Gets an `mdManifestResource` token for the resource with the specified name.| +|[GetAssemblyFromScope Method](imetadataassemblyimport-getassemblyfromscope-method.md)|Gets the token for the assembly in the current metadata scope.| +|[GetAssemblyProps Method](imetadataassemblyimport-getassemblyprops-method.md)|Gets the property settings of the specified assembly.| +|[GetAssemblyRefProps Method](imetadataassemblyimport-getassemblyrefprops-method.md)|Gets the property settings of the specified `mdAssemblyRef` token.| +|[GetExportedTypeProps Method](imetadataassemblyimport-getexportedtypeprops-method.md)|Gets the property settings of the specified COM type.| +|[GetFileProps Method](imetadataassemblyimport-getfileprops-method.md)|Gets the property settings of the specified file.| +|[GetManifestResourceProps Method](imetadataassemblyimport-getmanifestresourceprops-method.md)|Gets the property settings of the specified manifest resource.| + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md similarity index 57% rename from docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md rename to docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md index 45b8ed119d6db..dce238cda04e7 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataConverter::GetMetaDataFromTypeInfo Method" title: "IMetaDataConverter::GetMetaDataFromTypeInfo Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataConverter.GetMetaDataFromTypeInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataConverter::GetMetaDataFromTypeInfo" -helpviewer_keywords: +helpviewer_keywords: - "GetMetaDataFromTypeInfo method [.NET Framework metadata]" - "IMetaDataConverter::GetMetaDataFromTypeInfo method [.NET Framework metadata]" -ms.assetid: d44484bb-23a3-49c3-9e46-69d0d9ab4f0f -topic_type: +topic_type: - "apiref" --- # IMetaDataConverter::GetMetaDataFromTypeInfo Method -Gets a pointer to an [IMetaDataImport](imetadataimport-interface.md) instance that represents the metadata signature of the type library referenced by the specified `ITypeInfo` instance. - -## Syntax - -```cpp -HRESULT GetMetaDataFromTypeInfo ( - [in] ITypeInfo *pITI, - [out] IMetaDataImport **ppMDI -); -``` - -## Parameters - - `pITI` - [in] A pointer to an `ITypeInfo` object that refers to the type library. - - `ppMDI` - [out] A pointer to a location that receives the address of the `IMetaDataImport` instance that represents the metadata signature. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a pointer to an [IMetaDataImport](imetadataimport-interface.md) instance that represents the metadata signature of the type library referenced by the specified `ITypeInfo` instance. + +## Syntax + +```cpp +HRESULT GetMetaDataFromTypeInfo ( + [in] ITypeInfo *pITI, + [out] IMetaDataImport **ppMDI +); +``` + +## Parameters + + `pITI` + [in] A pointer to an `ITypeInfo` object that refers to the type library. + + `ppMDI` + [out] A pointer to a location that receives the address of the `IMetaDataImport` instance that represents the metadata signature. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md similarity index 63% rename from docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md rename to docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md index 858bae449c47b..01322d4ef4186 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataConverter::GetMetaDataFromTypeLib Method" title: "IMetaDataConverter::GetMetaDataFromTypeLib Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataConverter.GetMetaDataFromTypeLib" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataConverter::GetMetaDataFromTypeLib" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataConverter::GetMetaDataFromTypeLib method [.NET Framework metadata]" - "GetMetaDataFromTypeLib method [.NET Framework metadata]" -ms.assetid: 97dc3a56-adfa-431f-889e-06a35ac84d51 -topic_type: +topic_type: - "apiref" --- # IMetaDataConverter::GetMetaDataFromTypeLib Method -Gets an interface pointer to an [IMetaDataImport](imetadataimport-interface.md) instance that represents the metadata signature of the type library represented by the specified `ITypeLib` instance. - -## Syntax - -```cpp -HRESULT GetMetaDataFromTypeLib ( +Gets an interface pointer to an [IMetaDataImport](imetadataimport-interface.md) instance that represents the metadata signature of the type library represented by the specified `ITypeLib` instance. + +## Syntax + +```cpp +HRESULT GetMetaDataFromTypeLib ( [in] ITypeLib *pITL, - [out] IMetaDataImport **ppMDI -); -``` - -## Parameters - - `pITL` - [in] Pointer to an `ITypeLib` object that represents the type library. - - `ppMDI` - [out] Pointer to a location that receives the address of the `IMetaDataImport` instance that represents the metadata signature. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] IMetaDataImport **ppMDI +); +``` + +## Parameters + + `pITL` + [in] Pointer to an `ITypeLib` object that represents the type library. + + `ppMDI` + [out] Pointer to a location that receives the address of the `IMetaDataImport` instance that represents the metadata signature. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md new file mode 100644 index 0000000000000..907b69f7acbd8 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md @@ -0,0 +1,56 @@ +--- +description: "Learn more about: IMetaDataConverter::GetTypeLibFromMetaData Method" +title: "IMetaDataConverter::GetTypeLibFromMetaData Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataConverter.GetTypeLibFromMetaData" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataConverter::GetTypeLibFromMetaData" +helpviewer_keywords: + - "GetTypeLibFromMetaData method [.NET Framework metadata]" + - "IMetaDataConverter::GetTypeLibFromMetaData method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataConverter::GetTypeLibFromMetaData Method + +Gets a pointer to an `ITypeLib` instance that represents the type library that has the specified library and module names. + +## Syntax + +```cpp +HRESULT GetTypeLibFromMetaData ( + [in] BSTR strModule, + [in] BSTR strTlbName, + [out] ITypeLib **ppITL +); +``` + +## Parameters + + `strModule` + [in] The name of the type library's module. + + `strTlbName` + [in] The name of the type library. + + `ppITL` + [out] A pointer to a location that receives the address of the `ITypeLib` instance that represents the type library. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataConverter Interface](imetadataconverter-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataconverter-interface.md b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md similarity index 63% rename from docs/framework/unmanaged-api/metadata/imetadataconverter-interface.md rename to docs/core/unmanaged-api/metadata/imetadataconverter-interface.md index e44e632210c3a..9e74e78740ddc 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataconverter-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md @@ -2,42 +2,41 @@ description: "Learn more about: IMetaDataConverter Interface" title: "IMetaDataConverter Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataConverter" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataConverter" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataConverter interface [.NET Framework metadata]" -ms.assetid: 9caea662-0167-4267-b14a-2fa42c3be4ea -topic_type: +topic_type: - "apiref" --- # IMetaDataConverter Interface -Provides methods to map type libraries to their metadata signatures, and to convert from one to the other. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetMetaDataFromTypeInfo Method](imetadataconverter-getmetadatafromtypeinfo-method.md)|Gets a pointer to an [IMetaDataImport](imetadataimport-interface.md) instance that represents the metadata signature for the type library referenced by the specified `ITypeInfo` instance.| -|[GetMetaDataFromTypeLib Method](imetadataconverter-getmetadatafromtypelib-method.md)|Gets a pointer to an `IMetaDataImport` instance that represents the metadata signature for the type library represented by the specified `ITypeLib` instance.| -|[GetTypeLibFromMetaData Method](imetadataconverter-gettypelibfrommetadata-method.md)|Gets a pointer to an `ITypeLib` instance that represents the type library that has the specified module and library names.| - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides methods to map type libraries to their metadata signatures, and to convert from one to the other. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetMetaDataFromTypeInfo Method](imetadataconverter-getmetadatafromtypeinfo-method.md)|Gets a pointer to an [IMetaDataImport](imetadataimport-interface.md) instance that represents the metadata signature for the type library referenced by the specified `ITypeInfo` instance.| +|[GetMetaDataFromTypeLib Method](imetadataconverter-getmetadatafromtypelib-method.md)|Gets a pointer to an `IMetaDataImport` instance that represents the metadata signature for the type library represented by the specified `ITypeLib` instance.| +|[GetTypeLibFromMetaData Method](imetadataconverter-gettypelibfrommetadata-method.md)|Gets a pointer to an `ITypeLib` instance that represents the type library that has the specified module and library names.| + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenser-definescope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md similarity index 64% rename from docs/framework/unmanaged-api/metadata/imetadatadispenser-definescope-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md index fb82edb0811d1..961cca0efee67 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenser-definescope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IMetaDataDispenser::DefineScope Method" title: "IMetaDataDispenser::DefineScope Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenser.DefineScope" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenser::DefineScope" -helpviewer_keywords: +helpviewer_keywords: - "DefineScope method [.NET Framework metadata]" - "IMetaDataDispenser::DefineScope method [.NET Framework metadata]" -ms.assetid: af28db02-29af-45ac-aec6-8d6c6123c2ff -topic_type: +topic_type: - "apiref" --- # IMetaDataDispenser::DefineScope Method -Creates a new area in memory in which you can create new metadata. - -## Syntax - -```cpp -HRESULT DefineScope ( - [in] REFCLSID rclsid, - [in] DWORD dwCreateFlags, +Creates a new area in memory in which you can create new metadata. + +## Syntax + +```cpp +HRESULT DefineScope ( + [in] REFCLSID rclsid, + [in] DWORD dwCreateFlags, [in] REFIID riid, - [out] IUnknown **ppIUnk -); -``` - -## Parameters - - `rclsid` - [in] The CLSID of the version of metadata structures to be created. This value must be CLSID_CorMetaDataRuntime for .NET Framework version 2.0. - - `dwCreateFlags` - [in] Flags that specify options. This value must be zero for .NET Framework 2.0. - - `riid` - [in] The IID of the desired metadata interface to be returned; the caller will use the interface to create the new metadata. - - The value of `riid` must specify one of the "emit" interfaces. Valid values are IID_IMetaDataEmit, IID_IMetaDataAssemblyEmit, or IID_IMetaDataEmit2. - - `ppIUnk` - [out] The pointer to the returned interface. - -## Remarks - - `DefineScope` creates a set of in-memory metadata tables, generates a unique GUID (module version identifier, or MVID) for the metadata, and creates an entry in the module table for the compilation unit being emitted. - - You can attach attributes to the metadata scope as a whole by using the [IMetaDataEmit::SetModuleProps](imetadataemit-setmoduleprops-method.md) or [IMetaDataEmit::DefineCustomAttribute](imetadataemit-definecustomattribute-method.md) method, as appropriate. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] IUnknown **ppIUnk +); +``` + +## Parameters + + `rclsid` + [in] The CLSID of the version of metadata structures to be created. This value must be CLSID_CorMetaDataRuntime for .NET Framework version 2.0. + + `dwCreateFlags` + [in] Flags that specify options. This value must be zero for .NET Framework 2.0. + + `riid` + [in] The IID of the desired metadata interface to be returned; the caller will use the interface to create the new metadata. + + The value of `riid` must specify one of the "emit" interfaces. Valid values are IID_IMetaDataEmit, IID_IMetaDataAssemblyEmit, or IID_IMetaDataEmit2. + + `ppIUnk` + [out] The pointer to the returned interface. + +## Remarks + + `DefineScope` creates a set of in-memory metadata tables, generates a unique GUID (module version identifier, or MVID) for the metadata, and creates an entry in the module table for the compilation unit being emitted. + + You can attach attributes to the metadata scope as a whole by using the [IMetaDataEmit::SetModuleProps](imetadataemit-setmoduleprops-method.md) or [IMetaDataEmit::DefineCustomAttribute](imetadataemit-definecustomattribute-method.md) method, as appropriate. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataDispenser Interface](imetadatadispenser-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenser-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md similarity index 58% rename from docs/framework/unmanaged-api/metadata/imetadatadispenser-interface.md rename to docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md index 2a1fd2ec0825d..b8a4985bc0416 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenser-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md @@ -2,42 +2,41 @@ description: "Learn more about: IMetaDataDispenser Interface" title: "IMetaDataDispenser Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenser" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenser" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataDispenser interface [.NET Framework metadata]" -ms.assetid: 989840b3-9822-4ce5-a6c5-b375d3340a7a -topic_type: +topic_type: - "apiref" --- # IMetaDataDispenser Interface -Provides methods to create a new metadata scope, or open an existing one. - -## Methods - -|Method|Description| -|------------|-----------------| -|[DefineScope Method](imetadatadispenser-definescope-method.md)|Creates a new area in memory where you can create new metadata.| -|[OpenScope Method](imetadatadispenser-openscope-method.md)|Opens an existing, on-disk file and maps its metadata into memory.| -|[OpenScopeOnMemory Method](imetadatadispenser-openscopeonmemory-method.md)|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.| - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides methods to create a new metadata scope, or open an existing one. + +## Methods + +|Method|Description| +|------------|-----------------| +|[DefineScope Method](imetadatadispenser-definescope-method.md)|Creates a new area in memory where you can create new metadata.| +|[OpenScope Method](imetadatadispenser-openscope-method.md)|Opens an existing, on-disk file and maps its metadata into memory.| +|[OpenScopeOnMemory Method](imetadatadispenser-openscopeonmemory-method.md)|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.| + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenser-openscope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md similarity index 71% rename from docs/framework/unmanaged-api/metadata/imetadatadispenser-openscope-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md index f4152cb5a40a0..30cea8d004e29 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenser-openscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataDispenser::OpenScope Method" title: "IMetaDataDispenser::OpenScope Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenser.OpenScope" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenser::OpenScope" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataDispenser::OpenScope method [.NET Framework metadata]" - "OpenScope method, IMetaDataDispenser interface [.NET Framework metadata]" -ms.assetid: 65063ad5-e0d9-4c01-8f8b-9a5950109fa6 -topic_type: +topic_type: - "apiref" --- # IMetaDataDispenser::OpenScope Method -Opens an existing, on-disk file and maps its metadata into memory. - -## Syntax - -```cpp -HRESULT OpenScope ( +Opens an existing, on-disk file and maps its metadata into memory. + +## Syntax + +```cpp +HRESULT OpenScope ( [in] LPCWSTR szScope, [in] DWORD dwOpenFlags, [in] REFIID riid, - [out] IUnknown **ppIUnk -); -``` - -## Parameters - - `szScope` - [in] The name of the file to be opened. The file must contain common language runtime (CLR) metadata. - - `dwOpenFlags` - [in] A value of the [CorOpenFlags](coropenflags-enumeration.md) enumeration to specify the mode (read, write, and so on) for opening. - - `riid` - [in] 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. - - `ppIUnk` - [out] The pointer to the returned interface. - -## 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. - - If the target file does not contain CLR metadata, the `OpenScope` method will fail. - - In the .NET Framework version 1.0 and version 1.1, if a scope is opened with `dwOpenFlags` set to ofRead, it is eligible for sharing. That is, if subsequent calls to `OpenScope` pass in the name of a file that was previously opened, the existing scope is reused and a new set of data structures is not created. However, problems can arise due to this sharing. - - In .NET Framework version 2.0, scopes opened with `dwOpenFlags` set to ofRead are no longer shared. Use the ofReadOnly value to allow the scope to be shared. When a scope is shared, queries that use "read/write" metadata interfaces will fail. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] IUnknown **ppIUnk +); +``` + +## Parameters + + `szScope` + [in] The name of the file to be opened. The file must contain common language runtime (CLR) metadata. + + `dwOpenFlags` + [in] A value of the [CorOpenFlags](coropenflags-enumeration.md) enumeration to specify the mode (read, write, and so on) for opening. + + `riid` + [in] 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. + + `ppIUnk` + [out] The pointer to the returned interface. + +## 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. + + If the target file does not contain CLR metadata, the `OpenScope` method will fail. + + In the .NET Framework version 1.0 and version 1.1, if a scope is opened with `dwOpenFlags` set to ofRead, it is eligible for sharing. That is, if subsequent calls to `OpenScope` pass in the name of a file that was previously opened, the existing scope is reused and a new set of data structures is not created. However, problems can arise due to this sharing. + + In .NET Framework version 2.0, scopes opened with `dwOpenFlags` set to ofRead are no longer shared. Use the ofReadOnly value to allow the scope to be shared. When a scope is shared, queries that use "read/write" metadata interfaces will fail. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataDispenser Interface](imetadatadispenser-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md similarity index 70% rename from docs/framework/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md index 49f287ba57d6d..58689ad3fdcc1 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md @@ -2,74 +2,73 @@ description: "Learn more about: IMetaDataDispenser::OpenScopeOnMemory Method" title: "IMetaDataDispenser::OpenScopeOnMemory Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenser.OpenScopeOnMemory" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenser::OpenScopeOnMemory" -helpviewer_keywords: +helpviewer_keywords: - "OpenScopeOnMemory method [.NET Framework metadata]" - "IMetaDataDispenser::OpenScopeOnMemory method [.NET Framework metadata]" -ms.assetid: 14218249-bdec-48ae-b5fc-9f57f7ca8501 -topic_type: +topic_type: - "apiref" --- # IMetaDataDispenser::OpenScopeOnMemory Method -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 - -```cpp -HRESULT OpenScopeOnMemory ( +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 + +```cpp +HRESULT OpenScopeOnMemory ( [in] LPCVOID pData, [in] ULONG cbData, [in] DWORD dwOpenFlags, [in] REFIID riid, - [out] IUnknown **ppIUnk -); -``` - -## Parameters - - `pData` - [in] A pointer that specifies the starting address of the memory area. - - `cbData` - [in] The size of the memory area, in bytes. - - `dwOpenFlags` - [in] A value of the [CorOpenFlags](coropenflags-enumeration.md) enumeration to specify the mode (read, write, and so on) for opening. - - `riid` - [in] 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. - - `ppIUnk` - [out] The pointer to the returned interface. - -## 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 [IMetaDataDispenser::OpenScope](imetadatadispenser-openscope-method.md) 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 - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] IUnknown **ppIUnk +); +``` + +## Parameters + + `pData` + [in] A pointer that specifies the starting address of the memory area. + + `cbData` + [in] The size of the memory area, in bytes. + + `dwOpenFlags` + [in] A value of the [CorOpenFlags](coropenflags-enumeration.md) enumeration to specify the mode (read, write, and so on) for opening. + + `riid` + [in] 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. + + `ppIUnk` + [out] The pointer to the returned interface. + +## 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 [IMetaDataDispenser::OpenScope](imetadatadispenser-openscope-method.md) 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 + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataDispenser Interface](imetadatadispenser-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md new file mode 100644 index 0000000000000..12d7e84953c57 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md @@ -0,0 +1,73 @@ +--- +description: "Learn more about: IMetaDataDispenserEx::FindAssembly Method" +title: "IMetaDataDispenserEx::FindAssembly Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataDispenserEx.FindAssembly" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataDispenserEx::FindAssembly" +helpviewer_keywords: + - "FindAssembly method [.NET Framework metadata]" + - "IMetaDataDispenserEx::FindAssembly method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataDispenserEx::FindAssembly Method + +This method is not implemented. If called, it returns E_NOTIMPL. + +## Syntax + +```cpp +HRESULT FindAssembly( + [in] LPCWSTR szAppBase, + [in] LPCWSTR szPrivateBin, + [in] LPCWSTR szGlobalBin, + [in] LPCWSTR szAssemblyName, + [out] LPCWSTR szName, + [in] ULONG cchName, + [out] ULONG *pcName +); +``` + +## Parameters + + `szAppBase` + [in] Not used. + + `szPrivateBin` + [in] Not used. + + `szGlobalBin` + [in] Not used. + + `szAssemblyName` + [in] The assembly to be found. + + `szName` + [out] The simple name of the assembly. + + `cchName` + [in] The size, in bytes, of `szName`. + + `pcName` + [out] The number of characters actually returned in `szName`. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) +- [IMetaDataDispenser Interface](imetadatadispenser-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md new file mode 100644 index 0000000000000..8d73da3495efc --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md @@ -0,0 +1,77 @@ +--- +description: "Learn more about: IMetaDataDispenserEx::FindAssemblyModule Method" +title: "IMetaDataDispenserEx::FindAssemblyModule Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataDispenserEx.FindAssemblyModule" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataDispenserEx::FindAssemblyModule" +helpviewer_keywords: + - "FindAssemblyModule method [.NET Framework metadata]" + - "IMetaDataDispenserEx::FindAssemblyModule method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataDispenserEx::FindAssemblyModule Method + +This method is not implemented. If called, it returns E_NOTIMPL. + +## Syntax + +```cpp +HRESULT FindAssemblyModule( + [in] LPCWSTR szAppBase, + [in] LPCWSTR szPrivateBin, + [in] LPCWSTR szGlobalBin, + [in] LPCWSTR szAssemblyName, + [in] LPCWSTR szModuleName, + [out] LPCWSTR szName, + [in] ULONG cchName, + [out] ULONG *pcName +); +``` + +## Parameters + + `szAppBase` + [in] Not used. + + `szPrivateBin` + [in] Not used. + + `szGlobalBin` + [in] Not used. + + `szAssemblyName` + [in] The name of the module. + + `szModuleName` + [in] The assembly to be found. + + `szName` + [out] The simple name of the assembly. + + `cchName` + [in] The size, in bytes, of `szName`. + + `pcName` + [out] The number of characters actually returned in `szName`. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) +- [IMetaDataDispenser Interface](imetadatadispenser-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md index 798401d3db367..b8db8428a39be 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataDispenserEx::GetCORSystemDirectory Method" title: "IMetaDataDispenserEx::GetCORSystemDirectory Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenserEx.GetCORSystemDirectory" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenserEx::GetCORSystemDirectory" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataDispenserEx::GetCORSystemDirectory method [.NET Framework metadata]" - "GetCORSystemDirectory method [.NET Framework metadata]" -ms.assetid: d9e0f3b6-e106-4820-bada-5bfba34ce360 -topic_type: +topic_type: - "apiref" --- # IMetaDataDispenserEx::GetCORSystemDirectory Method -Gets the directory that holds the current common language runtime (CLR). This method is supported only for use by out-of-process debuggers. If called from another component, it will return E_NOTIMPL. - -## Syntax - -```cpp -HRESULT GetCORSystemDirectory ( +Gets the directory that holds the current common language runtime (CLR). This method is supported only for use by out-of-process debuggers. If called from another component, it will return E_NOTIMPL. + +## Syntax + +```cpp +HRESULT GetCORSystemDirectory ( [out] LPWSTR szBuffer, [in] DWORD cchBuffer, - [out] DWORD* pchBuffer -); -``` - -## Parameters - - `szBuffer` - [out] The buffer to receive the directory name. - - `cchBuffer` - [in] The size, in bytes, of `szBuffer`. - - `pchBuffer` - [out] The number of bytes actually returned in `szBuffer`. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] DWORD* pchBuffer +); +``` + +## Parameters + + `szBuffer` + [out] The buffer to receive the directory name. + + `cchBuffer` + [in] The size, in bytes, of `szBuffer`. + + `pchBuffer` + [out] The number of bytes actually returned in `szBuffer`. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md index d4f04afcbb255..c451c8c973d2b 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md @@ -2,70 +2,69 @@ description: "Learn more about: IMetaDataDispenserEx::GetOption Method" title: "IMetaDataDispenserEx::GetOption Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenserEx.GetOption" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenserEx::GetOption" -helpviewer_keywords: +helpviewer_keywords: - "GetOption method [.NET Framework metadata]" - "IMetaDataDispenserEx::GetOption method [.NET Framework metadata]" -ms.assetid: d7f794e5-8e25-4d65-850a-7c34fbfce87d -topic_type: +topic_type: - "apiref" --- # IMetaDataDispenserEx::GetOption Method -Gets the value of the specified option for the current metadata scope. The option controls how calls to the current metadata scope are handled. - -## Syntax - -```cpp -HRESULT GetOption ( +Gets the value of the specified option for the current metadata scope. The option controls how calls to the current metadata scope are handled. + +## Syntax + +```cpp +HRESULT GetOption ( [in] REFGUID optionId, - [out] const VARIANT *pValue -); -``` - -## Parameters - - `optionId` - [in] A pointer to a GUID that specifies the option to be retrieved. See the Remarks section for a list of supported GUIDs. - - `pValue` - [out] The value of the returned option. The type of this value will be a variant of the specified option's type. - -## Remarks - - The following list shows the GUIDs that are supported for this method. For descriptions, see the [IMetaDataDispenserEx::SetOption](imetadatadispenserex-setoption-method.md) method. If `optionId` is not in this list, this method returns HRESULT `E_INVALIDARG`, indicating an incorrect parameter. - -- MetaDataCheckDuplicatesFor - -- MetaDataRefToDefCheck - -- MetaDataNotificationForTokenMovement - -- MetaDataSetENC - -- MetaDataErrorIfEmitOutOfOrder - -- MetaDataGenerateTCEAdapters - -- MetaDataLinkerOptions - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] const VARIANT *pValue +); +``` + +## Parameters + + `optionId` + [in] A pointer to a GUID that specifies the option to be retrieved. See the Remarks section for a list of supported GUIDs. + + `pValue` + [out] The value of the returned option. The type of this value will be a variant of the specified option's type. + +## Remarks + + The following list shows the GUIDs that are supported for this method. For descriptions, see the [IMetaDataDispenserEx::SetOption](imetadatadispenserex-setoption-method.md) method. If `optionId` is not in this list, this method returns HRESULT `E_INVALIDARG`, indicating an incorrect parameter. + +- MetaDataCheckDuplicatesFor + +- MetaDataRefToDefCheck + +- MetaDataNotificationForTokenMovement + +- MetaDataSetENC + +- MetaDataErrorIfEmitOutOfOrder + +- MetaDataGenerateTCEAdapters + +- MetaDataLinkerOptions + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md similarity index 71% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-interface.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md index 323fed76c0c3e..8e73ab8973268 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md @@ -2,45 +2,44 @@ description: "Learn more about: IMetaDataDispenserEx Interface" title: "IMetaDataDispenserEx Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenserEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenserEx" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataDispenserEx interface [.NET Framework metadata]" -ms.assetid: 78b3629e-77a2-4406-89c3-56b5cc2c4594 -topic_type: +topic_type: - "apiref" --- # IMetaDataDispenserEx Interface -Extends the [IMetaDataDispenser Interface](imetadatadispenser-interface.md) interface to provide the capability to control how the metadata APIs operate on the current metadata scope. - -## Methods - -|Method|Description| -|------------|-----------------| -|[FindAssembly Method](imetadatadispenserex-findassembly-method.md)|This method is not implemented. If called, it returns E_NOTIMPL.| -|[FindAssemblyModule Method](imetadatadispenserex-findassemblymodule-method.md)|This method is not implemented. If called, it returns E_NOTIMPL.| -|[GetCORSystemDirectory Method](imetadatadispenserex-getcorsystemdirectory-method.md)|Gets the directory that holds the current common language runtime (CLR). This method is supported only for use by out-of-process debuggers. If called from another component, it will return E_NOTIMPL.| -|[GetOption Method](imetadatadispenserex-getoption-method.md)|Gets the value of the specified option for the current metadata scope. The option controls how calls to the current metadata scope are handled.| -|[OpenScopeOnITypeInfo Method](imetadatadispenserex-openscopeonitypeinfo-method.md)|This method is not implemented. If called, it returns E_NOTIMPL.| -|[SetOption Method](imetadatadispenserex-setoption-method.md)|Sets the specified option to a given value for the current metadata scope. The option controls how calls to the current metadata scope are handled.| - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Extends the [IMetaDataDispenser Interface](imetadatadispenser-interface.md) interface to provide the capability to control how the metadata APIs operate on the current metadata scope. + +## Methods + +|Method|Description| +|------------|-----------------| +|[FindAssembly Method](imetadatadispenserex-findassembly-method.md)|This method is not implemented. If called, it returns E_NOTIMPL.| +|[FindAssemblyModule Method](imetadatadispenserex-findassemblymodule-method.md)|This method is not implemented. If called, it returns E_NOTIMPL.| +|[GetCORSystemDirectory Method](imetadatadispenserex-getcorsystemdirectory-method.md)|Gets the directory that holds the current common language runtime (CLR). This method is supported only for use by out-of-process debuggers. If called from another component, it will return E_NOTIMPL.| +|[GetOption Method](imetadatadispenserex-getoption-method.md)|Gets the value of the specified option for the current metadata scope. The option controls how calls to the current metadata scope are handled.| +|[OpenScopeOnITypeInfo Method](imetadatadispenserex-openscopeonitypeinfo-method.md)|This method is not implemented. If called, it returns E_NOTIMPL.| +|[SetOption Method](imetadatadispenserex-setoption-method.md)|Sets the specified option to a given value for the current metadata scope. The option controls how calls to the current metadata scope are handled.| + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md new file mode 100644 index 0000000000000..089ce8fd76091 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md @@ -0,0 +1,61 @@ +--- +description: "Learn more about: IMetaDataDispenserEx::OpenScopeOnITypeInfo Method" +title: "IMetaDataDispenserEx::OpenScopeOnITypeInfo Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataDispenserEx.OpenScopeOnITypeInfo" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataDispenserEx::OpenScopeOnITypeInfo" +helpviewer_keywords: + - "OpenScopeOnITypeInfo method [.NET Framework metadata]" + - "IMetaDataDispenserEx::OpenScopeOnITypeInfo method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataDispenserEx::OpenScopeOnITypeInfo Method + +This method is not implemented. If called, it returns E_NOTIMPL. + +## Syntax + +```cpp +HRESULT OpenScopeOnITypeInfo ( + [in] ITypeInfo *pITI, + [in] DWORD dwOpenFlags, + [in] REFIID riid, + [out] IUnknown **ppIUnk +); +``` + +## Parameters + + `pITI` + [in] Pointer to an [ITypeInfo](/previous-versions/windows/desktop/api/oaidl/nn-oaidl-itypeinfo) interface that provides the type information on which to open the scope. + + `dwOpenFlags` + [in] The open mode flags. + + `riid` + [in] The desired interface. + + `ppIUnk` + [out] Pointer to a pointer to the returned interface. + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) +- [IMetaDataDispenser Interface](imetadatadispenser-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md similarity index 82% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md index c282d48d6933d..c9c211d49abe2 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataDispenserEx::SetOption Method" title: "IMetaDataDispenserEx::SetOption Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenserEx.SetOption" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenserEx::SetOption" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataDispenserEx::SetOption method [.NET Framework metadata]" - "SetOption method [.NET Framework metadata]" -ms.assetid: 9f1c7ccd-7fb2-41d8-aa00-24b823376527 -topic_type: +topic_type: - "apiref" --- # IMetaDataDispenserEx::SetOption Method -Sets the specified option to a given value for the current metadata scope. The option controls how calls to the current metadata scope are handled. - -## Syntax - -```cpp -HRESULT SetOption ( +Sets the specified option to a given value for the current metadata scope. The option controls how calls to the current metadata scope are handled. + +## Syntax + +```cpp +HRESULT SetOption ( [in] REFGUID optionId, - [in] const VARIANT *pValue -); -``` - -## Parameters - - `optionId` - [in] A pointer to a GUID that specifies the option to be set. - - `pValue` - [in] The value to use to set the option. The type of this value must be a variant of the specified option's type. - -## Remarks - - The following table lists the available GUIDs that the `optionId` parameter can point to and the corresponding valid values for the `pValue` parameter. - -|GUID|Description|`pValue` Parameter| -|----------|-----------------|------------------------| -|MetaDataCheckDuplicatesFor|Controls which items are checked for duplicates. Each time you call an [IMetaDataEmit](imetadataemit-interface.md) method that creates a new item, you can ask the method to check whether the item already exists in the current scope. For example, you can check for the existence of `mdMethodDef` items; in this case, when you call [IMetaDataEmit::DefineMethod](imetadataemit-definemethod-method.md), it will check that the method does not already exist in the current scope. This check uses the key that uniquely identifies a given method: parent type, name, and signature.|Must be a variant of type UI4, and must contain a combination of the values of the [CorCheckDuplicatesFor](corcheckduplicatesfor-enumeration.md) enumeration.| -|MetaDataRefToDefCheck|Controls which referenced items are converted to definitions. By default, the metadata engine will optimize the code by converting a referenced item to its definition if the referenced item is actually defined in the current scope.|Must be a variant of type UI4, and must contain a combination of the values of the [CorRefToDefCheck](correftodefcheck-enumeration.md) enumeration.| -|MetaDataNotificationForTokenMovement|Controls which token remaps occurring during a metadata merge generate callbacks. Use the [IMetaDataEmit::SetHandler](imetadataemit-sethandler-method.md) method to establish your [IMapToken](imaptoken-interface.md) interface.|Must be a variant of type UI4, and must contain a combination of the values of the [CorNotificationForTokenMovement](cornotificationfortokenmovement-enumeration.md) enumeration.| -|MetaDataSetENC|Controls the behavior of edit-and-continue (ENC). Only one mode of behavior can be set at a time.|Must be a variant of type UI4, and must contain a value of the [CorSetENC](corsetenc-enumeration.md) enumeration. The value is not a bitmask.| -|MetaDataErrorIfEmitOutOfOrder|Controls which emitted-out-of-order errors generate callbacks. Emitting metadata out of order is not fatal; however, if you emit metadata in an order that is favored by the metadata engine, the metadata is more compact and therefore can be more efficiently searched. Use the `IMetaDataEmit::SetHandler` method to establish your [IMetaDataError](imetadataerror-interface.md) interface.|Must be a variant of type UI4, and must contain a combination of the values of the [CorErrorIfEmitOutOfOrder](corerrorifemitoutoforder-enumeration.md) enumeration.| -|MetaDataImportOption|Controls which kinds of items that were deleted during an ENC are retrieved by an enumerator.|Must be a variant of type UI4, and must contain a combination of the values of the [CorImportOptions Enumeration](corimportoptions-enumeration.md) enumeration.| -|MetaDataThreadSafetyOptions|Controls whether the metadata engine obtains reader/writer locks, thereby ensuring thread safety. By default, the engine assumes that access is single-threaded by the caller, so no locks are obtained. Clients are responsible for maintaining proper thread synchronization when using the metadata API.|Must be a variant of type UI4, and must contain a value of the [CorThreadSafetyOptions](corthreadsafetyoptions-enumeration.md) enumeration. The value is not a bitmask.| -|MetaDataGenerateTCEAdapters|Controls whether the type library importer should generate the tightly coupled event (TCE) adapters for COM connection point containers.|Must be a variant of type BOOL. If `pValue` is set to `true`, the type library importer generates the TCE adapters.| -|MetaDataTypeLibImportNamespace|Specifies a non-default namespace for the type library that is being imported.|Must be either a null value or a variant of type BSTR. If `pValue` is a null value, the current namespace is set to null; otherwise, the current namespace is set to the string that is held in the variant's BSTR type.| -|MetaDataLinkerOptions|Controls whether the linker should generate an assembly or a .NET Framework module file.|Must be a variant of type UI4, and must contain a combination of the values of the [CorLinkerOptions](corlinkeroptions-enumeration.md) enumeration.| -|MetaDataRuntimeVersion|Specifies the version of the common language runtime against which this image was built. The version is stored as a string, such as "v1.0.3705".|Must be a null value, a VT_EMPTY value, or a variant of type BSTR. If `pValue` is null, the runtime version is set to null. If `pValue` is VT_EMPTY, the version is set to a default value, which is drawn from the version of Mscorwks.dll within which the metadata code is running. Otherwise, the runtime version is set to the string that is held in the variant's BSTR type.| -|MetaDataMergerOptions|Specifies options for merging metadata.|Must be a variant of type UI4, and must contain a combination of the values of the `MergeFlags` enumeration, which is described in the CorHdr.h file.| -|MetaDataPreserveLocalRefs|Disables optimizing local references into definitions.|Must contain a combination of the values of the [CorLocalRefPreservation](corlocalrefpreservation-enumeration.md) enumeration.| - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] const VARIANT *pValue +); +``` + +## Parameters + + `optionId` + [in] A pointer to a GUID that specifies the option to be set. + + `pValue` + [in] The value to use to set the option. The type of this value must be a variant of the specified option's type. + +## Remarks + + The following table lists the available GUIDs that the `optionId` parameter can point to and the corresponding valid values for the `pValue` parameter. + +|GUID|Description|`pValue` Parameter| +|----------|-----------------|------------------------| +|MetaDataCheckDuplicatesFor|Controls which items are checked for duplicates. Each time you call an [IMetaDataEmit](imetadataemit-interface.md) method that creates a new item, you can ask the method to check whether the item already exists in the current scope. For example, you can check for the existence of `mdMethodDef` items; in this case, when you call [IMetaDataEmit::DefineMethod](imetadataemit-definemethod-method.md), it will check that the method does not already exist in the current scope. This check uses the key that uniquely identifies a given method: parent type, name, and signature.|Must be a variant of type UI4, and must contain a combination of the values of the [CorCheckDuplicatesFor](corcheckduplicatesfor-enumeration.md) enumeration.| +|MetaDataRefToDefCheck|Controls which referenced items are converted to definitions. By default, the metadata engine will optimize the code by converting a referenced item to its definition if the referenced item is actually defined in the current scope.|Must be a variant of type UI4, and must contain a combination of the values of the [CorRefToDefCheck](correftodefcheck-enumeration.md) enumeration.| +|MetaDataNotificationForTokenMovement|Controls which token remaps occurring during a metadata merge generate callbacks. Use the [IMetaDataEmit::SetHandler](imetadataemit-sethandler-method.md) method to establish your [IMapToken](imaptoken-interface.md) interface.|Must be a variant of type UI4, and must contain a combination of the values of the [CorNotificationForTokenMovement](cornotificationfortokenmovement-enumeration.md) enumeration.| +|MetaDataSetENC|Controls the behavior of edit-and-continue (ENC). Only one mode of behavior can be set at a time.|Must be a variant of type UI4, and must contain a value of the [CorSetENC](corsetenc-enumeration.md) enumeration. The value is not a bitmask.| +|MetaDataErrorIfEmitOutOfOrder|Controls which emitted-out-of-order errors generate callbacks. Emitting metadata out of order is not fatal; however, if you emit metadata in an order that is favored by the metadata engine, the metadata is more compact and therefore can be more efficiently searched. Use the `IMetaDataEmit::SetHandler` method to establish your [IMetaDataError](imetadataerror-interface.md) interface.|Must be a variant of type UI4, and must contain a combination of the values of the [CorErrorIfEmitOutOfOrder](corerrorifemitoutoforder-enumeration.md) enumeration.| +|MetaDataImportOption|Controls which kinds of items that were deleted during an ENC are retrieved by an enumerator.|Must be a variant of type UI4, and must contain a combination of the values of the [CorImportOptions Enumeration](corimportoptions-enumeration.md) enumeration.| +|MetaDataThreadSafetyOptions|Controls whether the metadata engine obtains reader/writer locks, thereby ensuring thread safety. By default, the engine assumes that access is single-threaded by the caller, so no locks are obtained. Clients are responsible for maintaining proper thread synchronization when using the metadata API.|Must be a variant of type UI4, and must contain a value of the [CorThreadSafetyOptions](corthreadsafetyoptions-enumeration.md) enumeration. The value is not a bitmask.| +|MetaDataGenerateTCEAdapters|Controls whether the type library importer should generate the tightly coupled event (TCE) adapters for COM connection point containers.|Must be a variant of type BOOL. If `pValue` is set to `true`, the type library importer generates the TCE adapters.| +|MetaDataTypeLibImportNamespace|Specifies a non-default namespace for the type library that is being imported.|Must be either a null value or a variant of type BSTR. If `pValue` is a null value, the current namespace is set to null; otherwise, the current namespace is set to the string that is held in the variant's BSTR type.| +|MetaDataLinkerOptions|Controls whether the linker should generate an assembly or a .NET Framework module file.|Must be a variant of type UI4, and must contain a combination of the values of the [CorLinkerOptions](corlinkeroptions-enumeration.md) enumeration.| +|MetaDataRuntimeVersion|Specifies the version of the common language runtime against which this image was built. The version is stored as a string, such as "v1.0.3705".|Must be a null value, a VT_EMPTY value, or a variant of type BSTR. If `pValue` is null, the runtime version is set to null. If `pValue` is VT_EMPTY, the version is set to a default value, which is drawn from the version of Mscorwks.dll within which the metadata code is running. Otherwise, the runtime version is set to the string that is held in the variant's BSTR type.| +|MetaDataMergerOptions|Specifies options for merging metadata.|Must be a variant of type UI4, and must contain a combination of the values of the `MergeFlags` enumeration, which is described in the CorHdr.h file.| +|MetaDataPreserveLocalRefs|Disables optimizing local references into definitions.|Must contain a combination of the values of the [CorLocalRefPreservation](corlocalrefpreservation-enumeration.md) enumeration.| + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md similarity index 62% rename from docs/framework/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md index 595db479ea62f..a45bdf2e9c40d 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md @@ -2,50 +2,49 @@ description: "Learn more about: IMetaDataEmit::ApplyEditAndContinue Method" title: "IMetaDataEmit::ApplyEditAndContinue Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.ApplyEditAndContinue" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::ApplyEditAndContinue" -helpviewer_keywords: +helpviewer_keywords: - "ApplyEditAndContinue method [.NET Framework metadata]" - "IMetaDataEmit::ApplyEditAndContinue method [.NET Framework metadata]" -ms.assetid: 35991289-f389-495d-8caa-a6384fb1d557 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::ApplyEditAndContinue Method -Updates the current assembly scope with the changes made in the specified metadata. - -## Syntax - -```cpp +Updates the current assembly scope with the changes made in the specified metadata. + +## Syntax + +```cpp HRESULT ApplyEditAndContinue ( - [in] IUnknown *pImport -); -``` - -## Parameters + [in] IUnknown *pImport +); +``` + +## Parameters - `pImport` + `pImport` \[in\] Pointer to an [IUnknown](/cpp/atl/iunknown) object that represents the delta metadata from the portable executable (PE) file. - - The delta metadata is the block of metadata that includes the changes that were made to the copy of the module's actual metadata. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + + The delta metadata is the block of metadata that includes the changes that were made to the copy of the module's actual metadata. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md index c678afc2855cc..0331fa2844305 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataEmit::DefineCustomAttribute Method" title: "IMetaDataEmit::DefineCustomAttribute Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineCustomAttribute" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineCustomAttribute" -helpviewer_keywords: +helpviewer_keywords: - "DefineCustomAttribute method [.NET Framework metadata]" - "IMetaDataEmit::DefineCustomAttribute method [.NET Framework metadata]" -ms.assetid: 7dd14854-b756-4401-b167-88ca576dc8f0 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineCustomAttribute Method -Creates a definition for a custom attribute with the specified metadata signature, to be attached to the specified object, and gets a token to that custom attribute definition. - -## Syntax - -```cpp +Creates a definition for a custom attribute with the specified metadata signature, to be attached to the specified object, and gets a token to that custom attribute definition. + +## Syntax + +```cpp HRESULT DefineCustomAttribute ( [in] mdToken tkObj, [in] mdToken tkType, [in] void const *pCustomAttribute, [in] ULONG cbCustomAttribute, [out] mdCustomAttribute *pcv -); -``` - -## Parameters - - `tkObj` - [in] The token for the owner item. - - `tkType` - [in] The token that identifies the custom attribute. - - `pCustomAttribute` - [in] A pointer to the custom attribute. - - `cbCustomAttribute` - [in] The count of bytes in `pCustomAttribute`. - - `pcv` - [out] The `mdCustomAttribute` token assigned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tkObj` + [in] The token for the owner item. + + `tkType` + [in] The token that identifies the custom attribute. + + `pCustomAttribute` + [in] A pointer to the custom attribute. + + `cbCustomAttribute` + [in] The count of bytes in `pCustomAttribute`. + + `pcv` + [out] The `mdCustomAttribute` token assigned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md new file mode 100644 index 0000000000000..12424a85e5a5d --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md @@ -0,0 +1,81 @@ +--- +description: "Learn more about: IMetaDataEmit::DefineEvent Method" +title: "IMetaDataEmit::DefineEvent Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit.DefineEvent" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit::DefineEvent" +helpviewer_keywords: + - "IMetaDataEmit::DefineEvent method [.NET Framework metadata]" + - "DefineEvent method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit::DefineEvent Method + +Creates a definition for an event with the specified metadata signature, and gets a token to that event definition. + +## Syntax + +```cpp +HRESULT DefineEvent ( + [in] mdTypeDef td, + [in] LPCWSTR szEvent, + [in] DWORD dwEventFlags, + [in] mdToken tkEventType, + [in] mdMethodDef mdAddOn, + [in] mdMethodDef mdRemoveOn, + [in] mdMethodDef mdFire, + [in] mdMethodDef rmdOtherMethods[], + [out] mdEvent *pmdEvent +); +``` + +## Parameters + + `td` + [in] The token for the target class or interface. This is either a `mdTypeDef` or `mdTypeDefNil` token. + + `szEvent` + [in] The name of the event. + + `dwEventFlags` + [in] Event flags. + + `tkEventType` + [in] The token for the event class. This is a `mdTypeDef`, a `mdTypeRef`, or a `mdTokenNil` token. + + `mdAddOn` + [in] The method used to subscribe to the event, or null. + + `mdRemoveOn` + [in] The method used to unsubscribe to the event, or null. + + `mdFire` + [in] The method used (by a derived class) to raise the event. + + `rmdOtherMethods[]` + [in] An array of tokens for other methods associated with the event. The array is terminated with a `mdMethodDefNil` token. + + `pmdEvent` + [out] The metadata token assigned to the event. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataEmit Interface](imetadataemit-interface.md) +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definefield-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definefield-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md index 5420b6c68e907..13cf50a33ea3b 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definefield-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md @@ -2,28 +2,27 @@ description: "Learn more about: IMetaDataEmit::DefineField Method" title: "IMetaDataEmit::DefineField Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineField" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineField" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::DefineField method [.NET Framework metadata]" - "DefineField method, IMetaDataEmit interface [.NET Framework metadata" -ms.assetid: 6b5be4fc-2e86-499c-8b09-833160bca767 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineField Method -Creates a definition for a field with the specified metadata signature, and gets a token to that field definition. - -## Syntax - -```cpp +Creates a definition for a field with the specified metadata signature, and gets a token to that field definition. + +## Syntax + +```cpp HRESULT DefineField ( [in] mdTypeDef td, [in] LPCWSTR szName, @@ -34,48 +33,48 @@ HRESULT DefineField ( [in] void const *pValue, [in] ULONG cchValue, [out] mdFieldDef *pmd -); -``` - -## Parameters - - `td` - [in] The `mdTypeDef` token for the enclosing class or interface. - - `szName` - [in] The field name in Unicode. - - `dwFieldFlags` - [in] The field attributes. This is a bitmask of `CorFieldAttr` values. - - `pvSigBlob` - [in] The field signature as a BLOB. - - `cbSigBlob` - [in] The count of bytes in `pvSigBlob`. - - `dwCPlusTypeFlag` - [in] The `ELEMENT_TYPE_`*\** for the constant value. This is a `CorElementType` value. If not defining a constant value for the field, use `ELEMENT_TYPE_END`. - - `pValue` - [in] The constant value for the field. - - `cchValue` - [in] The size in (Unicode) characters of `pValue`. - - `pmd` - [out] The `mdFieldDef` token assigned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `td` + [in] The `mdTypeDef` token for the enclosing class or interface. + + `szName` + [in] The field name in Unicode. + + `dwFieldFlags` + [in] The field attributes. This is a bitmask of `CorFieldAttr` values. + + `pvSigBlob` + [in] The field signature as a BLOB. + + `cbSigBlob` + [in] The count of bytes in `pvSigBlob`. + + `dwCPlusTypeFlag` + [in] The `ELEMENT_TYPE_`*\** for the constant value. This is a `CorElementType` value. If not defining a constant value for the field, use `ELEMENT_TYPE_END`. + + `pValue` + [in] The constant value for the field. + + `cchValue` + [in] The size in (Unicode) characters of `pValue`. + + `pmd` + [out] The `mdFieldDef` token assigned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md similarity index 74% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md index 8b2650a398d3e..bcfb8aacbece6 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md @@ -2,88 +2,87 @@ description: "Learn more about: IMetaDataEmit::DefineImportMember Method" title: "IMetaDataEmit::DefineImportMember Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineImportMember" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineImportMember" -helpviewer_keywords: +helpviewer_keywords: - "DefineImportMember method [.NET Framework metadata]" - "IMetaDataEmit::DefineImportMember method [.NET Framework metadata]" -ms.assetid: c7dd94c6-335b-46ff-9dfe-505056db5673 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineImportMember Method -Creates a reference to the specified member of a type or module that is defined outside the current scope, and defines a token for that reference. - -## Syntax - -```cpp +Creates a reference to the specified member of a type or module that is defined outside the current scope, and defines a token for that reference. + +## Syntax + +```cpp HRESULT DefineImportMember ( [in] IMetaDataAssemblyImport *pAssemImport, [in] const void *pbHashValue, - [in] ULONG cbHashValue, + [in] ULONG cbHashValue, [in] IMetaDataImport *pImport, [in] mdToken mbMember, [in] IMetaDataAssemblyEmit *pAssemEmit, [in] mdToken tkParent, [out] mdMemberRef *pmr -); -``` - -## Parameters - - `pAssemImport` - [in] An [IMetaDataAssemblyImport](imetadataassemblyimport-interface.md) interface that represents the assembly from which the target member is imported. - - `pbHashValue` - [in] An array that contains the hash for the assembly specified by `pAssemImport`. - - `cbHashValue` - [in] The number of bytes in the `pbHashValue` array. - - `pImport` - [in] An [IMetaDataImport](imetadataimport-interface.md) interface that represents the metadata scope from which the target member is imported. - - `mbMember` - [in] The metadata token that specifies the target member. The token can be an `mdMethodDef` (for a member method), `mdProperty` (for a member property), or `mdFieldDef` (for a member field) token. - - `pAssemEmit` - [in] An [IMetaDataAssemblyEmit](imetadataassemblyemit-interface.md) interface that represents the assembly into which the target member is imported. - - `tkParent` - [in] The `mdTypeRef` or `mdModuleRef` token for the type or module, respectively, that owns the target member. - - `pmr` - [out] The `mdMemberRef` token that is defined in the current scope for the member reference. - -## Remarks - - The `DefineImportMember` method looks up the member, specified by `mbMember`, that is defined in another scope, specified by `pImport`, and retrieves its properties. It uses this information to call the [IMetaDataEmit::DefineMemberRef](imetadataemit-definememberref-method.md) method in the current scope to create the member reference. - - Generally, before you use the `DefineImportMember` method, you must create, in the current scope, a type reference or module reference for the target member's parent class, interface, or module. The metadata token for this reference is then passed in the `tkParent` argument. You do not need to create a reference to the target member's parent if it will be resolved later by the compiler or linker. To summarize: - -- If the target member is a field or method, use either the [IMetaDataEmit::DefineTypeRefByName](imetadataemit-definetyperefbyname-method.md) or the [IMetaDataEmit::DefineImportType](imetadataemit-defineimporttype-method.md) method to create a type reference, in the current scope, for the member's parent class or parent interface. - -- If the target member is a global variable or global function (that is, not a member of a class or interface), use the [IMetaDataEmit::DefineModuleRef](imetadataemit-definemoduleref-method.md) method to create a module reference, in the current scope, for the member's parent module. - -- If the target member's parent will be resolved later by the compiler or linker, then pass `mdTokenNil` in `tkParent`. The only scenario in which this applies is when a global function or global variable is being imported from a .obj file that will ultimately be linked into the current module and the metadata merged. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `pAssemImport` + [in] An [IMetaDataAssemblyImport](imetadataassemblyimport-interface.md) interface that represents the assembly from which the target member is imported. + + `pbHashValue` + [in] An array that contains the hash for the assembly specified by `pAssemImport`. + + `cbHashValue` + [in] The number of bytes in the `pbHashValue` array. + + `pImport` + [in] An [IMetaDataImport](imetadataimport-interface.md) interface that represents the metadata scope from which the target member is imported. + + `mbMember` + [in] The metadata token that specifies the target member. The token can be an `mdMethodDef` (for a member method), `mdProperty` (for a member property), or `mdFieldDef` (for a member field) token. + + `pAssemEmit` + [in] An [IMetaDataAssemblyEmit](imetadataassemblyemit-interface.md) interface that represents the assembly into which the target member is imported. + + `tkParent` + [in] The `mdTypeRef` or `mdModuleRef` token for the type or module, respectively, that owns the target member. + + `pmr` + [out] The `mdMemberRef` token that is defined in the current scope for the member reference. + +## Remarks + + The `DefineImportMember` method looks up the member, specified by `mbMember`, that is defined in another scope, specified by `pImport`, and retrieves its properties. It uses this information to call the [IMetaDataEmit::DefineMemberRef](imetadataemit-definememberref-method.md) method in the current scope to create the member reference. + + Generally, before you use the `DefineImportMember` method, you must create, in the current scope, a type reference or module reference for the target member's parent class, interface, or module. The metadata token for this reference is then passed in the `tkParent` argument. You do not need to create a reference to the target member's parent if it will be resolved later by the compiler or linker. To summarize: + +- If the target member is a field or method, use either the [IMetaDataEmit::DefineTypeRefByName](imetadataemit-definetyperefbyname-method.md) or the [IMetaDataEmit::DefineImportType](imetadataemit-defineimporttype-method.md) method to create a type reference, in the current scope, for the member's parent class or parent interface. + +- If the target member is a global variable or global function (that is, not a member of a class or interface), use the [IMetaDataEmit::DefineModuleRef](imetadataemit-definemoduleref-method.md) method to create a module reference, in the current scope, for the member's parent module. + +- If the target member's parent will be resolved later by the compiler or linker, then pass `mdTokenNil` in `tkParent`. The only scenario in which this applies is when a global function or global variable is being imported from a .obj file that will ultimately be linked into the current module and the metadata merged. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md similarity index 61% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md index 7b29f65a41d2f..6ccc475cafa0e 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md @@ -2,28 +2,27 @@ description: "Learn more about: IMetaDataEmit::DefineImportType Method" title: "IMetaDataEmit::DefineImportType Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineImportType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineImportType" -helpviewer_keywords: +helpviewer_keywords: - "DefineImportType method [.NET Framework metadata]" - "IMetaDataEmit::DefineImportType method [.NET Framework metadata]" -ms.assetid: 37fd27af-8062-4904-ace4-51bb78ec600a -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineImportType Method -Creates a reference to the specified type that is defined outside the current scope, and defines a token for that reference. - -## Syntax - -```cpp +Creates a reference to the specified type that is defined outside the current scope, and defines a token for that reference. + +## Syntax + +```cpp HRESULT DefineImportType ( [in] IMetaDataAssemblyImport *pAssemImport, [in] const void *pbHashValue, @@ -31,47 +30,47 @@ HRESULT DefineImportType ( [in] IMetaDataImport *pImport, [in] mdTypeDef tdImport, [in] IMetaDataAssemblyEmit *pAssemEmit, - [out] mdTypeRef *ptr -); -``` - -## Parameters - - `pAssemImport` - [in] An [IMetaDataAssemblyImport](imetadataassemblyimport-interface.md) interface that represents the assembly from which the target type is imported. - - `pbHashValue` - [in] An array that contains the hash for the assembly specified by `pAssemImport`. - - `cbHashValue` - [in] The number of bytes in the `pbHashValue` array. - - `pImport` - [in] An [IMetaDataImport](imetadataimport-interface.md) interface that represents the metadata scope from which the target type is imported. - - `tdImport` - [in] An `mdTypeDef` token that specifies the target type. - - `pAssemEmit` - [in] An [IMetaDataAssemblyEmit](imetadataassemblyemit-interface.md) interface that represents the assembly into which the target type is imported. - - `ptr` - [out] The `mdTypeRef` token that is defined in the current scope for the type reference. - -## Remarks - - Prior to calling the [IMetaDataEmit::DefineImportMember](imetadataemit-defineimportmember-method.md) method, you can use the `DefineImportType` method to create a type reference, in the current scope, for the member's parent class or parent interface. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] mdTypeRef *ptr +); +``` + +## Parameters + + `pAssemImport` + [in] An [IMetaDataAssemblyImport](imetadataassemblyimport-interface.md) interface that represents the assembly from which the target type is imported. + + `pbHashValue` + [in] An array that contains the hash for the assembly specified by `pAssemImport`. + + `cbHashValue` + [in] The number of bytes in the `pbHashValue` array. + + `pImport` + [in] An [IMetaDataImport](imetadataimport-interface.md) interface that represents the metadata scope from which the target type is imported. + + `tdImport` + [in] An `mdTypeDef` token that specifies the target type. + + `pAssemEmit` + [in] An [IMetaDataAssemblyEmit](imetadataassemblyemit-interface.md) interface that represents the assembly into which the target type is imported. + + `ptr` + [out] The `mdTypeRef` token that is defined in the current scope for the type reference. + +## Remarks + + Prior to calling the [IMetaDataEmit::DefineImportMember](imetadataemit-defineimportmember-method.md) method, you can use the `DefineImportType` method to create a type reference, in the current scope, for the member's parent class or parent interface. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definememberref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definememberref-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md index a0eb48064cba7..f3c3d53efc63c 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definememberref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataEmit::DefineMemberRef Method" title: "IMetaDataEmit::DefineMemberRef Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineMemberRef" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineMemberRef" -helpviewer_keywords: +helpviewer_keywords: - "DefineMemberRef method [.NET Framework metadata]" - "IMetaDataEmit::DefineMemberRef method [.NET Framework metadata]" -ms.assetid: 21b5bcb8-ea75-4962-8acc-ad17584061e5 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineMemberRef Method -Defines a reference to a member of a module outside the current scope, and gets a token to that reference definition. - -## Syntax - -```cpp +Defines a reference to a member of a module outside the current scope, and gets a token to that reference definition. + +## Syntax + +```cpp HRESULT DefineMemberRef ( [in] mdToken tkImport, [in] LPCWSTR szName, [in] PCCOR_SIGNATURE pvSigBlob, [in] ULONG cbSigBlob, [out] mdMemberRef *pmr -); -``` - -## Parameters - - `tkImport` - [in] Token for the target member's class or interface, if the member is not global; if the member is global, the `mdModuleRef` token for that other file. - - `szName` - [in] The name of the target member. - - `pvSigBlob` - [in] The signature of the target member. - - `cbSigBlob` - [in] The count of bytes in `pvSigBlob`. - - `pmr` - [out] The `mdMemberRef` token assigned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tkImport` + [in] Token for the target member's class or interface, if the member is not global; if the member is global, the `mdModuleRef` token for that other file. + + `szName` + [in] The name of the target member. + + `pvSigBlob` + [in] The signature of the target member. + + `cbSigBlob` + [in] The count of bytes in `pvSigBlob`. + + `pmr` + [out] The `mdMemberRef` token assigned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definemethod-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md similarity index 71% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definemethod-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md index ccaa8aadd1bee..28791fc53a5d8 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definemethod-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md @@ -2,28 +2,27 @@ description: "Learn more about: IMetaDataEmit::DefineMethod Method" title: "IMetaDataEmit::DefineMethod Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineMethod" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineMethod" -helpviewer_keywords: +helpviewer_keywords: - "DefineMethod method [.NET Framework metadata]" - "IMetaDataEmit::DefineMethod method [.NET Framework metadata]" -ms.assetid: 3e2102c5-48b7-4c0e-b805-7e2b5e156e3d -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineMethod Method -Creates a definition for a method or global function with the specified signature, and returns a token to that method definition. - -## Syntax - -```cpp +Creates a definition for a method or global function with the specified signature, and returns a token to that method definition. + +## Syntax + +```cpp HRESULT DefineMethod ( [in] mdTypeDef td, [in] LPCWSTR szName, @@ -32,87 +31,87 @@ HRESULT DefineMethod ( [in] ULONG cbSigBlob, [in] ULONG ulCodeRVA, [in] DWORD dwImplFlags, - [out] mdMethodDef *pmd -); -``` - -## Parameters - - `td` - [in] The `mdTypedef` token of the parent class or parent interface of the method. Set `td` to `mdTokenNil`, if you are defining a global function. - - `szName` - [in] The member name in Unicode. - - `dwMethodFlags` - [in] A value of the [CorMethodAttr](cormethodattr-enumeration.md) enumeration that specifies the attributes of the method or global function. - - `pvSigBlob` - [in] The method signature. The signature is persisted as supplied. If you need to specify additional information for any parameters, use the [IMetaDataEmit::SetParamProps](imetadataemit-setparamprops-method.md) method. - - `cbSigBlob` - [in] The count of bytes in `pvSigBlob`. - - `ulCodeRVA` - [in] The address of the code. - - `dwImplFlags` - [in] A value of the [CorMethodImpl](cormethodimpl-enumeration.md) enumeration that specifies the implementation features of the method. - - `pmd` - [out] The member token. - -## Remarks - - The metadata API guarantees to persist methods in the same order as the caller emits them for a given enclosing class or interface, which is specified in the `td` parameter. - - Additional information regarding the use of `DefineMethod` and particular parameter settings is given below. - -## Slots in the V-table - - The runtime uses method definitions to set up v-table slots. In the case where one or more slots need to be skipped, such as to preserve parity with a COM interface layout, a dummy method is defined to take up the slot or slots in the v-table; set the `dwMethodFlags` to the `mdRTSpecialName` value of the [CorMethodAttr](cormethodattr-enumeration.md) enumeration and specify the name as: - + [out] mdMethodDef *pmd +); +``` + +## Parameters + + `td` + [in] The `mdTypedef` token of the parent class or parent interface of the method. Set `td` to `mdTokenNil`, if you are defining a global function. + + `szName` + [in] The member name in Unicode. + + `dwMethodFlags` + [in] A value of the [CorMethodAttr](cormethodattr-enumeration.md) enumeration that specifies the attributes of the method or global function. + + `pvSigBlob` + [in] The method signature. The signature is persisted as supplied. If you need to specify additional information for any parameters, use the [IMetaDataEmit::SetParamProps](imetadataemit-setparamprops-method.md) method. + + `cbSigBlob` + [in] The count of bytes in `pvSigBlob`. + + `ulCodeRVA` + [in] The address of the code. + + `dwImplFlags` + [in] A value of the [CorMethodImpl](cormethodimpl-enumeration.md) enumeration that specifies the implementation features of the method. + + `pmd` + [out] The member token. + +## Remarks + + The metadata API guarantees to persist methods in the same order as the caller emits them for a given enclosing class or interface, which is specified in the `td` parameter. + + Additional information regarding the use of `DefineMethod` and particular parameter settings is given below. + +## Slots in the V-table + + The runtime uses method definitions to set up v-table slots. In the case where one or more slots need to be skipped, such as to preserve parity with a COM interface layout, a dummy method is defined to take up the slot or slots in the v-table; set the `dwMethodFlags` to the `mdRTSpecialName` value of the [CorMethodAttr](cormethodattr-enumeration.md) enumeration and specify the name as: + _VtblGap\<*SequenceNumber*>\<\_*CountOfSlots*> - - where *SequenceNumber* is the sequence number of the method and *CountOfSlots* is the number of slots to skip in the v-table. If *CountOfSlots* is omitted, 1 is assumed. These dummy methods are not callable from either managed or unmanaged code and any attempt to call them, from either managed or unmanaged code, generates an exception. Their only purpose is to take up space in the v-table that the runtime generates for COM integration. - -## Duplicate Methods - - You should not define duplicate methods. That is, you should not call `DefineMethod` with a duplicate set of values in the `td`, `wzName`, and `pvSig` parameters. (These three parameters together uniquely define the method.). However, you can use a duplicate triple provided that, for one of the method definitions, you set the `mdPrivateScope` bit in the `dwMethodFlags` parameter. (The `mdPrivateScope` bit means that the compiler will not emit a reference to this method definition.) - -## Method Implementation Information - - Information about the method implementation is often not known at the time the method is declared. Therefore, you do not need to pass values in the `ulCodeRVA` and `dwImplFlags` parameters when calling `DefineMethod`. The values can be supplied later through [IMetaDataEmit::SetMethodImplFlags](imetadataemit-setmethodimplflags-method.md) or [IMetaDataEmit::SetRVA](imetadataemit-setrva-method.md), as appropriate. - - In some situations, such as platform invocation (PInvoke) or COM interop scenarios, the method body will not be supplied, and `ulCodeRVA` should be set to zero. In these situations, the method should not be tagged as abstract, because the runtime will locate the implementation. - -## Defining a Method for PInvoke - - For each unmanaged function to be called through PInvoke, you must define a managed method that represents the target unmanaged function. To define the managed method, use `DefineMethod` with some of the parameters set to certain values, depending on the way in which PInvoke is used: - -- True PInvoke - involves invocation of an external unmanaged method that resides in an unmanaged DLL. - -- Local PInvoke - involves invocation of a native unmanaged method that is embedded in the current managed module. - - The parameter settings are given in the following table. - -|Parameter|Values for true PInvoke|Values for local PInvoke| -|---------------|-----------------------------|------------------------------| -|`dwMethodFlags`||Set `mdStatic`; clear `mdSynchronized` and `mdAbstract`.| -|`pvSigBlob`|A valid common language runtime (CLR) method signature with parameters that are valid managed types.|A valid CLR method signature with parameters that are valid managed types.| -|`ulCodeRVA`||0| -|`dwImplFlags`|Set `miCil` and `miManaged`.|Set `miNative` and `miUnmanaged`.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + + where *SequenceNumber* is the sequence number of the method and *CountOfSlots* is the number of slots to skip in the v-table. If *CountOfSlots* is omitted, 1 is assumed. These dummy methods are not callable from either managed or unmanaged code and any attempt to call them, from either managed or unmanaged code, generates an exception. Their only purpose is to take up space in the v-table that the runtime generates for COM integration. + +## Duplicate Methods + + You should not define duplicate methods. That is, you should not call `DefineMethod` with a duplicate set of values in the `td`, `wzName`, and `pvSig` parameters. (These three parameters together uniquely define the method.). However, you can use a duplicate triple provided that, for one of the method definitions, you set the `mdPrivateScope` bit in the `dwMethodFlags` parameter. (The `mdPrivateScope` bit means that the compiler will not emit a reference to this method definition.) + +## Method Implementation Information + + Information about the method implementation is often not known at the time the method is declared. Therefore, you do not need to pass values in the `ulCodeRVA` and `dwImplFlags` parameters when calling `DefineMethod`. The values can be supplied later through [IMetaDataEmit::SetMethodImplFlags](imetadataemit-setmethodimplflags-method.md) or [IMetaDataEmit::SetRVA](imetadataemit-setrva-method.md), as appropriate. + + In some situations, such as platform invocation (PInvoke) or COM interop scenarios, the method body will not be supplied, and `ulCodeRVA` should be set to zero. In these situations, the method should not be tagged as abstract, because the runtime will locate the implementation. + +## Defining a Method for PInvoke + + For each unmanaged function to be called through PInvoke, you must define a managed method that represents the target unmanaged function. To define the managed method, use `DefineMethod` with some of the parameters set to certain values, depending on the way in which PInvoke is used: + +- True PInvoke - involves invocation of an external unmanaged method that resides in an unmanaged DLL. + +- Local PInvoke - involves invocation of a native unmanaged method that is embedded in the current managed module. + + The parameter settings are given in the following table. + +|Parameter|Values for true PInvoke|Values for local PInvoke| +|---------------|-----------------------------|------------------------------| +|`dwMethodFlags`||Set `mdStatic`; clear `mdSynchronized` and `mdAbstract`.| +|`pvSigBlob`|A valid common language runtime (CLR) method signature with parameters that are valid managed types.|A valid CLR method signature with parameters that are valid managed types.| +|`ulCodeRVA`||0| +|`dwImplFlags`|Set `miCil` and `miManaged`.|Set `miNative` and `miUnmanaged`.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md similarity index 57% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md index 414ac9f8363c5..f69ef40a78b55 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataEmit::DefineMethodImpl Method" title: "IMetaDataEmit::DefineMethodImpl Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineMethodImpl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineMethodImpl" -helpviewer_keywords: +helpviewer_keywords: - "DefineMethodImpl method [.NET Framework metadata]" - "IMetaDataEmit::DefineMethodImpl method [.NET Framework metadata]" -ms.assetid: 9dcc8b3d-33ee-4c7c-8d6f-322c57b94a0f -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineMethodImpl Method -Creates a definition for implementation of a method inherited from an interface, and returns a token to that method-implementation definition. - -## Syntax - -```cpp +Creates a definition for implementation of a method inherited from an interface, and returns a token to that method-implementation definition. + +## Syntax + +```cpp HRESULT DefineMethodImpl ( [in] mdTypeDef td, [in] mdToken tkBody, - [in] mdToken tkDecl -); -``` - -## Parameters - - `td` - [in] The `mdTypedef` token of the implementing class. - - `tkBody` - [in] The `mdMethodDef` or `mdMemberRef` token of the code body. - - `tkDecl` - [in] The `mdMethodDef` or `mdMemberRef` token of the interface method being implemented. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] mdToken tkDecl +); +``` + +## Parameters + + `td` + [in] The `mdTypedef` token of the implementing class. + + `tkBody` + [in] The `mdMethodDef` or `mdMemberRef` token of the code body. + + `tkDecl` + [in] The `mdMethodDef` or `mdMemberRef` token of the interface method being implemented. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md similarity index 55% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md index 5a623a76311a9..c7e17f5736255 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit::DefineModuleRef Method" title: "IMetaDataEmit::DefineModuleRef Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineModuleRef" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineModuleRef" -helpviewer_keywords: +helpviewer_keywords: - "DefineModuleRef method [.NET Framework metadata]" - "IMetaDataEmit::DefineModuleRef method [.NET Framework metadata]" -ms.assetid: f2833594-d90b-4a71-9a53-34b12470c64a -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineModuleRef Method -Creates the metadata signature for a module with the specified name. - -## Syntax - -```cpp +Creates the metadata signature for a module with the specified name. + +## Syntax + +```cpp HRESULT DefineModuleRef ( [in] LPCWSTR szName, [out] mdModuleRef *pmur -); -``` - -## Parameters - - `szName` - [in] The name of the other metadata file, typically a DLL. This is the file name only. Do not use a full path name. - - `pmur` - [out] The assigned `mdModuleRef` token. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `szName` + [in] The name of the other metadata file, typically a DLL. This is the file name only. Do not use a full path name. + + `pmur` + [out] The assigned `mdModuleRef` token. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md similarity index 58% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md index 950927d266bb3..44d6e111289c6 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IMetaDataEmit::DefineNestedType Method" title: "IMetaDataEmit::DefineNestedType Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineNestedType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineNestedType" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::DefineNestedType method [.NET Framework metadata]" - "DefineNestedType method [.NET Framework metadata]" -ms.assetid: 1e994de6-4628-459c-b967-b34be1e9fe4f -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineNestedType Method -Creates the metadata signature of a type definition, returns an `mdTypeDef` token for that type, and specifies that the defined type is a member of the type referenced by the `tdEncloser` parameter. - -## Syntax - -```cpp +Creates the metadata signature of a type definition, returns an `mdTypeDef` token for that type, and specifies that the defined type is a member of the type referenced by the `tdEncloser` parameter. + +## Syntax + +```cpp HRESULT DefineNestedType ( - [in] LPCWSTR szTypeDef, + [in] LPCWSTR szTypeDef, [in] DWORD dwTypeDefFlags, [in] mdToken tkExtends, [in] mdToken rtkImplements[], [in] mdTypeDef tdEncloser, - [out] mdTypeDef *ptd -); -``` - -## Parameters - - `szTypeDef` - [in] The name of the type in Unicode. - - `dwTypeDefFlags` - [in] `TypeDef` attributes. This is a bitmask of `CorTypeAttr` values. - - `tkExtends` - [in] The token of the base class. This is either a `mdTypeDef` or a `mdTypeRef` token. - - `rtkImplements`[] - [in] An array of tokens that specify the interfaces that this class or interface implements. - - `tdEncloser` - [in] The token of the enclosing type. The last element of the array must be `mdTokenNil`. - - `ptd` - [out] The `mdTypeDef` token assigned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] mdTypeDef *ptd +); +``` + +## Parameters + + `szTypeDef` + [in] The name of the type in Unicode. + + `dwTypeDefFlags` + [in] `TypeDef` attributes. This is a bitmask of `CorTypeAttr` values. + + `tkExtends` + [in] The token of the base class. This is either a `mdTypeDef` or a `mdTypeRef` token. + + `rtkImplements`[] + [in] An array of tokens that specify the interfaces that this class or interface implements. + + `tdEncloser` + [in] The token of the enclosing type. The last element of the array must be `mdTokenNil`. + + `ptd` + [out] The `mdTypeDef` token assigned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-defineparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineparam-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md index 67f497753807c..5f1d490f43379 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-defineparam-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md @@ -2,80 +2,79 @@ description: "Learn more about: IMetaDataEmit::DefineParam Method" title: "IMetaDataEmit::DefineParam Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineParam" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineParam" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::DefineParam method [.NET Framework metadata]" - "DefineParam method [.NET Framework metadata]" -ms.assetid: d86a3d14-4796-4909-9591-dfafe3de5ce4 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineParam Method -Creates a parameter definition with the specified signature for the method referenced by the specified token, and gets a token for that parameter definition. - -## Syntax - -```cpp -HRESULT DefineParam ( +Creates a parameter definition with the specified signature for the method referenced by the specified token, and gets a token for that parameter definition. + +## Syntax + +```cpp +HRESULT DefineParam ( [in] mdMethodDef md, [in] ULONG ulParamSeq, [in] LPCWSTR szName, [in] DWORD dwParamFlags, [in] DWORD dwCPlusTypeFlag, - [in] void const *pValue, + [in] void const *pValue, [in] ULONG cchValue, [out] mdParamDef *ppd -); -``` - -## Parameters - - `md` - [in] The token for the method whose parameter is being defined. - - `ulParamSeq` - [in] The parameter sequence number. - - `szName` - [in] The name of the parameter in Unicode. - - `dwParamFlags` - [in] Flags for the parameter. This is a bitmask of `CorParamAttr` values. - - `dwCPlusTypeFlag` - [in] `ELEMENT_TYPE_`*\** for the constant value. - - `pValue` - [in] The constant value for the parameter. - - `cchValue` - [in] The size, in Unicode characters, of `pValue`. - - `ppd` - [out] The `mdParamDef` token assigned. - -## Remarks - - The sequence values in `ulParamSeq` begin with 1 for parameters. A return value has a sequence number of 0. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `md` + [in] The token for the method whose parameter is being defined. + + `ulParamSeq` + [in] The parameter sequence number. + + `szName` + [in] The name of the parameter in Unicode. + + `dwParamFlags` + [in] Flags for the parameter. This is a bitmask of `CorParamAttr` values. + + `dwCPlusTypeFlag` + [in] `ELEMENT_TYPE_`*\** for the constant value. + + `pValue` + [in] The constant value for the parameter. + + `cchValue` + [in] The size, in Unicode characters, of `pValue`. + + `ppd` + [out] The `mdParamDef` token assigned. + +## Remarks + + The sequence values in `ulParamSeq` begin with 1 for parameters. A return value has a sequence number of 0. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md index 11f332bcc7f50..12a55ee6ec116 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataEmit::DefinePermissionSet Method" title: "IMetaDataEmit::DefinePermissionSet Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefinePermissionSet" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefinePermissionSet" -helpviewer_keywords: +helpviewer_keywords: - "DefinePermissionSet method [.NET Framework metadata]" - "IMetaDataEmit::DefinePermissionSet method [.NET Framework metadata]" -ms.assetid: 36cffbf7-82ca-4cf9-bf60-50ab491ac2d9 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefinePermissionSet Method -Creates a definition for a permission set with the specified metadata signature, and gets a token to that permission set definition. - -## Syntax - -```cpp -HRESULT DefinePermissionSet ( +Creates a definition for a permission set with the specified metadata signature, and gets a token to that permission set definition. + +## Syntax + +```cpp +HRESULT DefinePermissionSet ( [in] mdToken tk, [in] DWORD dwAction, [in] void const *pvPermission, [in] ULONG cbPermission, [out] mdPermission *ppm -); -``` - -## Parameters - - `tk` - [in] The object to be decorated. - - `dwAction` - [in] A [CorDeclSecurity](cordeclsecurity-enumeration.md) value that specifies the type of declarative security to be used. - - `pvPermission` - [in] The permission BLOB. - - `cbPermission` - [in] The size, in bytes, of `pvPermission`. - - `ppm` - [out] The returned permission token. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tk` + [in] The object to be decorated. + + `dwAction` + [in] A [CorDeclSecurity](cordeclsecurity-enumeration.md) value that specifies the type of declarative security to be used. + + `pvPermission` + [in] The permission BLOB. + + `cbPermission` + [in] The size, in bytes, of `pvPermission`. + + `ppm` + [out] The returned permission token. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md index 78cbfaa9db1a1..e17dcea024ab4 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataEmit::DefinePinvokeMap Method" title: "IMetaDataEmit::DefinePinvokeMap Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefinePinvokeMap" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefinePinvokeMap" -helpviewer_keywords: +helpviewer_keywords: - "DefinePinvokeMap method [.NET Framework metadata]" - "IMetaDataEmit::DefinePinvokeMap method [.NET Framework metadata]" -ms.assetid: 03abf921-5154-4070-88fa-10b7092901fb -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefinePinvokeMap Method -Sets features of the PInvoke signature of the method referenced by the specified token. - -## Syntax - -```cpp +Sets features of the PInvoke signature of the method referenced by the specified token. + +## Syntax + +```cpp HRESULT DefinePinvokeMap ( [in] mdToken tk, [in] DWORD dwMappingFlags, [in] LPCWSTR szImportName, [in] mdModuleRef mrImportDLL -); -``` - -## Parameters - - `tk` - [in] The token for the target method. - - `dwMappingFlags` - [in] Flags used by PInvoke to do the mapping. - - `szImportName` - [in] The name of the target export method in an unmanaged DLL. - - `mrImportDLL` - [in] The token for the target native DLL. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tk` + [in] The token for the target method. + + `dwMappingFlags` + [in] Flags used by PInvoke to do the mapping. + + `szImportName` + [in] The name of the target export method in an unmanaged DLL. + + `mrImportDLL` + [in] The token for the target native DLL. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-defineproperty-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineproperty-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md index a02008be7ebb3..4186189acd323 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-defineproperty-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md @@ -2,28 +2,27 @@ description: "Learn more about: IMetaDataEmit::DefineProperty Method" title: "IMetaDataEmit::DefineProperty Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineProperty" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineProperty" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::DefineProperty method [.NET Framework metadata]" - "DefineProperty method [.NET Framework metadata]" -ms.assetid: 5c4c1dc2-d40d-4173-bbe6-7058fb21c98f -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineProperty Method -Creates a property definition for the specified type, with the specified `get` and `set` method accessors, and gets a token to that property definition. - -## Syntax - -```cpp +Creates a property definition for the specified type, with the specified `get` and `set` method accessors, and gets a token to that property definition. + +## Syntax + +```cpp HRESULT DefineProperty ( [in] mdTypeDef td, [in] LPCWSTR szProperty, @@ -37,57 +36,57 @@ HRESULT DefineProperty ( [in] mdMethodDef mdGetter, [in] mdMethodDef rmdOtherMethods[], [out] mdProperty *pmdProp -); -``` - -## Parameters - - `td` - [in] The token for class or interface on which the property is being defined. - - `szProperty` - [in] The name of the property. - - `dwPropFlags` - [in] The property flags. - - `pvSig` - [in] The property signature. - - `cbSig` - [in] The count of bytes in `pvSig`. - - `dwCPlusTypeFlag` - [in] The type of the property's default value. - - `pValue` - [in] The default value for the property. - - `cchValue` - [in] The count of (Unicode) characters in `pValue`. - - `mdSetter` - [in] The method that sets the property value. - - `mdGetter` - [in] The method that gets the property value. - - `rmdOtherMethods[]` - [in] An array of other methods associated with the property. Terminate the array with an `mdTokenNil`. - - `pmdProp` - [out] The `mdProperty` token assigned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `td` + [in] The token for class or interface on which the property is being defined. + + `szProperty` + [in] The name of the property. + + `dwPropFlags` + [in] The property flags. + + `pvSig` + [in] The property signature. + + `cbSig` + [in] The count of bytes in `pvSig`. + + `dwCPlusTypeFlag` + [in] The type of the property's default value. + + `pValue` + [in] The default value for the property. + + `cchValue` + [in] The count of (Unicode) characters in `pValue`. + + `mdSetter` + [in] The method that sets the property value. + + `mdGetter` + [in] The method that gets the property value. + + `rmdOtherMethods[]` + [in] An array of other methods associated with the property. Terminate the array with an `mdTokenNil`. + + `pmdProp` + [out] The `mdProperty` token assigned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md index 5166df9c1dafb..0403c73d66691 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataEmit::DefineSecurityAttributeSet Method" title: "IMetaDataEmit::DefineSecurityAttributeSet Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineSecurityAttributeSet" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineSecurityAttributeSet" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::DefineSecurityAttributeSet method [.NET Framework metadata]" - "DefineSecurityAttributeSet method [.NET Framework metadata]" -ms.assetid: 27064ca2-4186-4433-90a7-3b297785e891 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineSecurityAttributeSet Method -Creates a set of security permissions to attach to the object referenced by the specified token. - -## Syntax - -```cpp +Creates a set of security permissions to attach to the object referenced by the specified token. + +## Syntax + +```cpp HRESULT DefineSecurityAttributeSet ( [in] mdToken tkObj, [in] COR_SECATTR rSecAttrs[], [in] ULONG cSecAttrs, [out] ULONG *pulErrorAttr -); -``` - -## Parameters - - `tkObj` - [in] The token to which the security information is attached. - - `rSecAttrs` - [in] An array of `COR_SECATTR` structures. - - `cSecAttrs` - [in] The number of elements in `rSecAttrs`. - - `pulErrorAttr` - [out] If the method fails, specifies the index in `rSecAttrs` of the element that caused the problem. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tkObj` + [in] The token to which the security information is attached. + + `rSecAttrs` + [in] An array of `COR_SECATTR` structures. + + `cSecAttrs` + [in] The number of elements in `rSecAttrs`. + + `pulErrorAttr` + [out] If the method fails, specifies the index in `rSecAttrs` of the element that caused the problem. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definetypedef-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md similarity index 68% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definetypedef-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md index 98aec3ab9867b..49c4d70575a07 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definetypedef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataEmit::DefineTypeDef Method" title: "IMetaDataEmit::DefineTypeDef Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineTypeDef" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineTypeDef" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::DefineTypeDef method [.NET Framework metadata]" - "DefineTypeDef method [.NET Framework metadata]" -ms.assetid: dd11c485-be95-4b97-9cd8-68679a4fb432 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineTypeDef Method -Creates a type definition for a common language runtime type, and gets a metadata token for that type definition. - -## Syntax - -```cpp +Creates a type definition for a common language runtime type, and gets a metadata token for that type definition. + +## Syntax + +```cpp HRESULT DefineTypeDef ( [in] LPCWSTR szTypeDef, [in] DWORD dwTypeDefFlags, [in] mdToken tkExtends, [in] mdToken rtkImplements[], - [out] mdTypeDef *ptd -); -``` - -## Parameters - - `szTypeDef` - [in] The name of the type in Unicode. - - `dwTypeDefFlags` - [in] `TypeDef` attributes. This is a bitmask of `CoreTypeAttr` values. - - `tkExtends` - [in] The token of the base class. It must be either an `mdTypeDef` or an `mdTypeRef` token. - - `rtkImplements` - [in] An array of tokens specifying the interfaces that this class or interface implements. - - `ptd` - [out] The `mdTypeDef` token assigned. - -## Remarks - - A flag in `dwTypeDefFlags` specifies whether the type being created is a common type system reference type (class or interface) or a common type system value type. - - Depending on the parameters supplied, this method, as a side effect, may also create an `mdInterfaceImpl` record for each interface that is inherited or implemented by this type. However, this method does not return any of these `mdInterfaceImpl` tokens. If a client wants to later add or modify an `mdInterfaceImpl` token, it must use the `IMetaDataImport` interface to enumerate them. If you want to use COM semantics of the `[default]` interface, you should supply the default interface as the first element in `rtkImplements`; a custom attribute set on the class will indicate that the class has a default interface (which is always assumed to be the first `mdInterfaceImpl` token declared for the class). - - Each element of the `rtkImplements` array holds an `mdTypeDef` or `mdTypeRef` token. The last element in the array must be `mdTokenNil`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] mdTypeDef *ptd +); +``` + +## Parameters + + `szTypeDef` + [in] The name of the type in Unicode. + + `dwTypeDefFlags` + [in] `TypeDef` attributes. This is a bitmask of `CoreTypeAttr` values. + + `tkExtends` + [in] The token of the base class. It must be either an `mdTypeDef` or an `mdTypeRef` token. + + `rtkImplements` + [in] An array of tokens specifying the interfaces that this class or interface implements. + + `ptd` + [out] The `mdTypeDef` token assigned. + +## Remarks + + A flag in `dwTypeDefFlags` specifies whether the type being created is a common type system reference type (class or interface) or a common type system value type. + + Depending on the parameters supplied, this method, as a side effect, may also create an `mdInterfaceImpl` record for each interface that is inherited or implemented by this type. However, this method does not return any of these `mdInterfaceImpl` tokens. If a client wants to later add or modify an `mdInterfaceImpl` token, it must use the `IMetaDataImport` interface to enumerate them. If you want to use COM semantics of the `[default]` interface, you should supply the default interface as the first element in `rtkImplements`; a custom attribute set on the class will indicate that the class has a default interface (which is always assumed to be the first `mdInterfaceImpl` token declared for the class). + + Each element of the `rtkImplements` array holds an `mdTypeDef` or `mdTypeRef` token. The last element in the array must be `mdTokenNil`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md similarity index 55% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md index 6f0a678ca7582..4a8a41ee2d310 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md @@ -2,66 +2,65 @@ description: "Learn more about: IMetaDataEmit::DefineTypeRefByName Method" title: "IMetaDataEmit::DefineTypeRefByName Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineTypeRefByName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineTypeRefByName" -helpviewer_keywords: +helpviewer_keywords: - "DefineTypeRefByName method [.NET Framework metadata]" - "IMetaDataEmit::DefineTypeRefByName method [.NET Framework metadata]" -ms.assetid: c30a4ce3-2d3e-411a-98df-e62ac4a5dd50 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineTypeRefByName Method -Gets a metadata token for a type that is defined in the specified scope, which is outside the current scope. - -## Syntax - -```cpp +Gets a metadata token for a type that is defined in the specified scope, which is outside the current scope. + +## Syntax + +```cpp HRESULT DefineTypeRefByName ( [in] mdToken tkResolutionScope, [in] LPCWSTR szName, [out] mdTypeRef *ptr -); -``` - -## Parameters - - `tkResolutionScope` - [in] The token specifying the resolution scope. The following token types are valid: - -- `mdModuleRef`, if the type is defined in the same assembly in which the caller is defined. - -- `mdAssemblyRef`, if the type is defined in an assembly other than the one in which the caller is defined. - -- `mdTypeRef`, if the type is a nested type. - -- `mdModule`, if the type is defined in the same module in which the caller is defined. - -- Null, if the type is defined globally. - - `szName` - [in] The name of the target type in Unicode. - - `ptr` - [out] A pointer to the `mdTypeRef` token that is assigned to the type. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tkResolutionScope` + [in] The token specifying the resolution scope. The following token types are valid: + +- `mdModuleRef`, if the type is defined in the same assembly in which the caller is defined. + +- `mdAssemblyRef`, if the type is defined in an assembly other than the one in which the caller is defined. + +- `mdTypeRef`, if the type is a nested type. + +- `mdModule`, if the type is defined in the same module in which the caller is defined. + +- Null, if the type is defined globally. + + `szName` + [in] The name of the target type in Unicode. + + `ptr` + [out] A pointer to the `mdTypeRef` token that is assigned to the type. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md new file mode 100644 index 0000000000000..969476596dd47 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: IMetaDataEmit::DefineUserString Method" +title: "IMetaDataEmit::DefineUserString Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit.DefineUserString" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit::DefineUserString" +helpviewer_keywords: + - "DefineUserString method [.NET Framework metadata]" + - "IMetaDataEmit::DefineUserString method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit::DefineUserString Method + +Gets a metadata token for the specified literal string. + +## Syntax + +```cpp +HRESULT DefineUserString ( + [in] LPCWSTR szString, + [in] ULONG cchString, + [out] mdString *pstk +); +``` + +## Parameters + + `szString` + [in] The user string to store. + + `cchString` + [in] The count of wide characters in `szString`. + + `pstk` + [out] The string token assigned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataEmit Interface](imetadataemit-interface.md) +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md index b1e5f444249c8..7336df2333691 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataEmit::DeleteClassLayout Method" title: "IMetaDataEmit::DeleteClassLayout Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DeleteClassLayout" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DeleteClassLayout" -helpviewer_keywords: +helpviewer_keywords: - "DeleteClassLayout method [.NET Framework metadata]" - "IMetaDataEmit::DeleteClassLayout method [.NET Framework metadata]" -ms.assetid: 65a4ad49-fa49-4b36-8ed1-76dd6a185ab4 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DeleteClassLayout Method -Destroys the class layout metadata signature for the type represented by the specified token. - -## Syntax - -```cpp -HRESULT DeleteClassLayout ( - [in] mdTypeDef td -); -``` - -## Parameters - - `td` - [in] An `mdTypeDef` metadata token that represents the type for which the class layout will be deleted. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Destroys the class layout metadata signature for the type represented by the specified token. + +## Syntax + +```cpp +HRESULT DeleteClassLayout ( + [in] mdTypeDef td +); +``` + +## Parameters + + `td` + [in] An `mdTypeDef` metadata token that represents the type for which the class layout will be deleted. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md similarity index 55% rename from docs/framework/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md index 4fb511e628d50..88afefec60fbd 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataEmit::DeleteFieldMarshal Method" title: "IMetaDataEmit::DeleteFieldMarshal Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DeleteFieldMarshal" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DeleteFieldMarshal" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::DeleteFieldMarshal method [.NET Framework metadata]" - "DeleteFieldMarshal method [.NET Framework metadata]" -ms.assetid: 7c75aef9-c742-4b33-a14b-56ff94b0f725 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DeleteFieldMarshal Method -Destroys the PInvoke marshalling metadata signature for the object referenced by the specified token. - -## Syntax - -```cpp -HRESULT DeleteFieldMarshal ( - [in] mdToken tk -); -``` - -## Parameters - - `tk` - [in] An `mdFieldDef` or `mdParamDef` token that represents the field or parameter for which to delete the marshalling metadata signature. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Destroys the PInvoke marshalling metadata signature for the object referenced by the specified token. + +## Syntax + +```cpp +HRESULT DeleteFieldMarshal ( + [in] mdToken tk +); +``` + +## Parameters + + `tk` + [in] An `mdFieldDef` or `mdParamDef` token that represents the field or parameter for which to delete the marshalling metadata signature. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md similarity index 55% rename from docs/framework/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md index 5b0fef36d3fdd..a8afbd64def42 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataEmit::DeletePinvokeMap Method" title: "IMetaDataEmit::DeletePinvokeMap Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DeletePinvokeMap" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DeletePinvokeMap" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::DeletePinvokeMap method [.NET Framework metadata]" - "DeletePinvokeMap method [.NET Framework metadata]" -ms.assetid: 3c4f6b54-5ce7-4a2a-83e1-6dec16441f50 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DeletePinvokeMap Method -Destroys the PInvoke mapping metadata for the object referenced by the specified token. - -## Syntax - -```cpp +Destroys the PInvoke mapping metadata for the object referenced by the specified token. + +## Syntax + +```cpp HRESULT DeletePinvokeMap ( [in] mdToken tk -); -``` - -## Parameters - - `tk` - [in] An `mdFieldDef` or `mdMethodDef` token that represents the object for which to delete the PInvoke mapping metadata. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tk` + [in] An `mdFieldDef` or `mdMethodDef` token that represents the object for which to delete the PInvoke mapping metadata. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md new file mode 100644 index 0000000000000..2fa9225b56424 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: IMetaDataEmit::DeleteToken Method" +title: "IMetaDataEmit::DeleteToken Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit.DeleteToken" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit::DeleteToken" +helpviewer_keywords: + - "DeleteToken method [.NET Framework metadata]" + - "IMetaDataEmit::DeleteToken method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit::DeleteToken Method + +Deletes the specified token from the current metadata scope. + +## Syntax + +```cpp +HRESULT DeleteToken ( + [in] mdToken tkObj +); +``` + +## Parameters + + `tkObj` + [in] The token to be deleted. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataEmit Interface](imetadataemit-interface.md) +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-getsavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md similarity index 71% rename from docs/framework/unmanaged-api/metadata/imetadataemit-getsavesize-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md index a6471bd3877ee..e003ad11df5ae 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-getsavesize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md @@ -2,66 +2,65 @@ description: "Learn more about: IMetaDataEmit::GetSaveSize Method" title: "IMetaDataEmit::GetSaveSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.GetSaveSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::GetSaveSize" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::GetSaveSize method [.NET Framework metadata]" - "GetSaveSize method [.NET Framework metadata]" -ms.assetid: 8aea2e2c-23a3-4cda-9a06-e19f97383830 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::GetSaveSize Method -Gets the estimated binary size of the assembly and its metadata in the current scope. - -## Syntax - -```cpp -HRESULT GetSaveSize ( - [in] CorSaveSize fSave, - [out] DWORD *pdwSaveSize -); -``` - -## Parameters - - `fSave` - [in] A value of the [CorSaveSize](corsavesize-enumeration.md) enumeration that specifies whether to get an accurate or approximate size. Only three values are valid: cssAccurate, cssQuick, and cssDiscardTransientCAs: - -- cssAccurate returns the exact save size but takes longer to calculate. - -- cssQuick returns a size, padded for safety, but takes less time to calculate. - -- cssDiscardTransientCAs tells `GetSaveSize` that it can throw away discardable custom attributes. - - `pdwSaveSize` - [out] A pointer to the size that is required to save the file. - -## Remarks - - `GetSaveSize` calculates the space required, in bytes, to save the assembly and all its metadata in the current scope. (A call to the [IMetaDataEmit::SaveToStream](imetadataemit-savetostream-method.md) method would emit this number of bytes.) - - If the caller implements the [IMapToken](imaptoken-interface.md) interface (through [IMetaDataEmit::SetHandler](imetadataemit-sethandler-method.md) or [IMetaDataEmit::Merge](imetadataemit-merge-method.md)), `GetSaveSize` will perform two passes over the metadata to optimize and compress it. Otherwise, no optimizations are performed. - - If optimization is performed, the first pass simply sorts the metadata structures to tune the performance of import-time searches. This step typically results in moving records around, with the side effect that tokens retained by the tool for future reference are invalidated. The metadata does not inform the caller of these token changes until after the second pass, however. In the second pass, various optimizations are performed that are intended to reduce the overall size of the metadata, such as optimizing away (early binding) `mdTypeRef` and `mdMemberRef` tokens when the reference is to a type or member that is declared in the current metadata scope. In this pass, another round of token mapping occurs. After this pass, the metadata engine notifies the caller, through its `IMapToken` interface, of any changed token values. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - +Gets the estimated binary size of the assembly and its metadata in the current scope. + +## Syntax + +```cpp +HRESULT GetSaveSize ( + [in] CorSaveSize fSave, + [out] DWORD *pdwSaveSize +); +``` + +## Parameters + + `fSave` + [in] A value of the [CorSaveSize](corsavesize-enumeration.md) enumeration that specifies whether to get an accurate or approximate size. Only three values are valid: cssAccurate, cssQuick, and cssDiscardTransientCAs: + +- cssAccurate returns the exact save size but takes longer to calculate. + +- cssQuick returns a size, padded for safety, but takes less time to calculate. + +- cssDiscardTransientCAs tells `GetSaveSize` that it can throw away discardable custom attributes. + + `pdwSaveSize` + [out] A pointer to the size that is required to save the file. + +## Remarks + + `GetSaveSize` calculates the space required, in bytes, to save the assembly and all its metadata in the current scope. (A call to the [IMetaDataEmit::SaveToStream](imetadataemit-savetostream-method.md) method would emit this number of bytes.) + + If the caller implements the [IMapToken](imaptoken-interface.md) interface (through [IMetaDataEmit::SetHandler](imetadataemit-sethandler-method.md) or [IMetaDataEmit::Merge](imetadataemit-merge-method.md)), `GetSaveSize` will perform two passes over the metadata to optimize and compress it. Otherwise, no optimizations are performed. + + If optimization is performed, the first pass simply sorts the metadata structures to tune the performance of import-time searches. This step typically results in moving records around, with the side effect that tokens retained by the tool for future reference are invalidated. The metadata does not inform the caller of these token changes until after the second pass, however. In the second pass, various optimizations are performed that are intended to reduce the overall size of the metadata, such as optimizing away (early binding) `mdTypeRef` and `mdMemberRef` tokens when the reference is to a type or member that is declared in the current metadata scope. In this pass, another round of token mapping occurs. After this pass, the metadata engine notifies the caller, through its `IMapToken` interface, of any changed token values. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md new file mode 100644 index 0000000000000..05b694096c1af --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: IMetaDataEmit::GetTokenFromSig Method" +title: "IMetaDataEmit::GetTokenFromSig Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit.GetTokenFromSig" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit::GetTokenFromSig" +helpviewer_keywords: + - "IMetaDataEmit::GetTokenFromSig method [.NET Framework metadata]" + - "GetTokenFromSig method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit::GetTokenFromSig Method + +Gets a token for the specified metadata signature. + +## Syntax + +```cpp +HRESULT GetTokenFromSig ( + [in] PCCOR_SIGNATURE pvSig, + [in] ULONG cbSig, + [out] mdSignature *pmsig +); +``` + +## Parameters + + `pvSig` + [in] The signature to be persisted and stored. + + `cbSig` + [in] The count of bytes in `pvSig`. + + `pmsig` + [out] The `mdSignature` token assigned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataEmit Interface](imetadataemit-interface.md) +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md index 6998a139cfe23..e0ba0629727f1 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataEmit::GetTokenFromTypeSpec Method" title: "IMetaDataEmit::GetTokenFromTypeSpec Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.GetTokenFromTypeSpec" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::GetTokenFromTypeSpec" -helpviewer_keywords: +helpviewer_keywords: - "GetTokenFromTypeSpec method [.NET Framework metadata]" - "IMetaDataEmit::GetTokenFromTypeSpec method [.NET Framework metadata]" -ms.assetid: 7de6447a-a751-49d8-87e2-951cee77b536 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::GetTokenFromTypeSpec Method -Gets a metadata token for the type with the specified metadata signature. - -## Syntax - -```cpp +Gets a metadata token for the type with the specified metadata signature. + +## Syntax + +```cpp HRESULT GetTokenFromTypeSpec ( [in] PCCOR_SIGNATURE pvSig, [in] ULONG cbSig, [out] mdTypeSpec *ptypespec -); -``` - -## Parameters - - `pvSig` - [in] The signature being defined. - - `cbSig` - [in] The count of bytes in `pvSig`. - - `ptypespec` - [out] The `mdTypeSpec` token assigned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `pvSig` + [in] The signature being defined. + + `cbSig` + [in] The count of bytes in `pvSig`. + + `ptypespec` + [out] The `mdTypeSpec` token assigned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md similarity index 75% rename from docs/framework/unmanaged-api/metadata/imetadataemit-interface.md rename to docs/core/unmanaged-api/metadata/imetadataemit-interface.md index 1af10de0ad2ac..0b866baef8707 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md @@ -2,88 +2,87 @@ description: "Learn more about: IMetaDataEmit Interface" title: "IMetaDataEmit Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit interface [.NET Framework metadata]" -ms.assetid: 3b48fd47-7397-4e2c-8bec-8157aa08978c -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit Interface -Provides methods to create, modify, and save metadata about the assembly in the currently defined scope. The metadata can be stored in memory or saved to disk. - -## Methods - -|Method|Description| -|------------|-----------------| -|[ApplyEditAndContinue Method](imetadataemit-applyeditandcontinue-method.md)|Updates the current assembly scope with the changes made in the specified `pImport`.| -|[DefineCustomAttribute Method](imetadataemit-definecustomattribute-method.md)|Creates a definition for a custom attribute with the specified metadata signature, to be attached to the specified object, and gets a token to that custom attribute definition.| -|[DefineEvent Method](imetadataemit-defineevent-method.md)|Creates a definition for an event with the specified metadata signature, and gets a token to that event definition.| -|[DefineField Method](imetadataemit-definefield-method.md)|Creates a definition for a field with the specified metadata signature, and gets a token to that field definition.| -|[DefineImportMember Method](imetadataemit-defineimportmember-method.md)|Creates a definition for a member of a type that is defined in a module outside the current scope, and gets a token for that reference definition.| -|[DefineImportType Method](imetadataemit-defineimporttype-method.md)|Creates a definition for a reference to a type that is defined in a module outside the current scope, and gets a token to that reference definition.| -|[DefineMemberRef Method](imetadataemit-definememberref-method.md)|Creates a definition for a reference to a member of a module outside the current scope, and gets a token to that reference definition.| -|[DefineMethod Method](imetadataemit-definemethod-method.md)|Creates a definition for a method with the specified signature, and returns a token to that method definition.| -|[DefineMethodImpl Method](imetadataemit-definemethodimpl-method.md)|Creates a definition for implementation of a method inherited from an interface, and returns a token to that method-implementation definition.| -|[DefineModuleRef Method](imetadataemit-definemoduleref-method.md)|Creates the metadata signature for a module with the specified name.| -|[DefineNestedType Method](imetadataemit-definenestedtype-method.md)|Creates the metadata signature of a type definition and returns an `mdTypeDef` token for that type, additionally specifying that the defined type is a member of the type referenced by `tdEncloser`.| -|[DefineParam Method](imetadataemit-defineparam-method.md)|Creates a parameter definition with the specified signature for the method referenced by the specified token, and gets a token for that parameter definition.| -|[DefinePermissionSet Method](imetadataemit-definepermissionset-method.md)|Creates a definition for a permission set with the specified metadata signature, and gets a token to that permission set definition.| -|[DefinePinvokeMap Method](imetadataemit-definepinvokemap-method.md)|Sets features of the PInvoke signature of the method referenced by the specified token.| -|[DefineProperty Method](imetadataemit-defineproperty-method.md)|Creates a property definition for the specified type, with the specified `get` and `set` method accessors, and gets a token to that property definition.| -|[DefineSecurityAttributeSet Method](imetadataemit-definesecurityattributeset-method.md)|Creates a set of security permissions to attach to the object referenced by the specified token.| -|[DefineTypeDef Method](imetadataemit-definetypedef-method.md)|Creates a type definition for a common language runtime type, and gets a metadata token to that type definition.| -|[DefineTypeRefByName Method](imetadataemit-definetyperefbyname-method.md)|Gets a metadata token for a type that is defined in another module outside the current scope.| -|[DefineUserString Method](imetadataemit-defineuserstring-method.md)|Gets a metadata token for the specified literal string.| -|[DeleteClassLayout Method](imetadataemit-deleteclasslayout-method.md)|Destroys the class layout metadata signature for the type referenced by the specified token.| -|[DeleteFieldMarshal Method](imetadataemit-deletefieldmarshal-method.md)|Destroys the PInvoke marshalling metadata signature for the object referenced by the specified token.| -|[DeletePinvokeMap Method](imetadataemit-deletepinvokemap-method.md)|Destroys the PInvoke mapping metadata for the object referenced by the specified token.| -|[DeleteToken Method](imetadataemit-deletetoken-method.md)|Deletes the specified token from the current metadata scope.| -|[GetSaveSize Method](imetadataemit-getsavesize-method.md)|Gets the estimated binary size of the assembly in the current scope.| -|[GetTokenFromSig Method](imetadataemit-gettokenfromsig-method.md)|Gets a token for the specified metadata signature.| -|[GetTokenFromTypeSpec Method](imetadataemit-gettokenfromtypespec-method.md)|Gets a metadata token for the type with the specified metadata signature.| -|[Merge Method](imetadataemit-merge-method.md)|Adds the specified imported scope to the list of scopes to be merged.| -|[MergeEnd Method](imetadataemit-mergeend-method.md)|Merges into the current scope all the metadata scopes specified by one or more prior calls to `IMetaDataEmit::Merge`.| -|[Save Method](imetadataemit-save-method.md)|Saves all metadata in the current scope to the file at the specified address.| -|[SaveToMemory Method](imetadataemit-savetomemory-method.md)|Saves all metadata in the current scope to the specified area of memory.| -|[SaveToStream Method](imetadataemit-savetostream-method.md)|Saves all metadata in the current scope to the specified `IStream`.| -|[SetClassLayout Method](imetadataemit-setclasslayout-method.md)|Sets or updates the class layout signature of a type defined by a prior call to `IMetaDataEmit::DefineTypeDef`.| -|[SetCustomAttributeValue Method](imetadataemit-setcustomattributevalue-method.md)|Sets or updates the value of a custom attribute defined by a prior call to `IMetaDataEmit::DefineCustomAttribute`.| -|[SetEventProps Method](imetadataemit-seteventprops-method.md)|Sets or updates the specified feature of an event defined by a prior call to `IMetaDataEmit::DefineEvent`.| -|[SetFieldMarshal Method](imetadataemit-setfieldmarshal-method.md)|Sets the PInvoke marshalling information for the field, method return, or method parameter referenced by the specified token.| -|[SetFieldProps Method](imetadataemit-setfieldprops-method.md)|Sets or updates the default value for the field referenced by the specified field token.| -|[SetFieldRVA Method](imetadataemit-setfieldrva-method.md)|Sets a global variable value for the relative virtual address of the field referenced by the specified token.| -|[SetHandler Method](imetadataemit-sethandler-method.md)|Sets the method referenced by the specified `IUnknown` pointer as a notification callback for token remaps.| -|[SetMethodImplFlags Method](imetadataemit-setmethodimplflags-method.md)|Sets or updates the metadata signature of the inherited method implementation referenced by the specified token.| -|[SetMethodProps Method](imetadataemit-setmethodprops-method.md)|Sets or updates the feature, stored at the specified relative virtual address, of a method defined by a prior call to `IMetaDataEmit::DefineMethod`.| -|[SetModuleProps Method](imetadataemit-setmoduleprops-method.md)|Updates references to a module defined by a prior call to `IMetaDataEmit::DefineModuleRef`.| -|[SetParamProps Method](imetadataemit-setparamprops-method.md)|Sets or changes features of a method parameter that was defined by a prior call to `IMetaDataEmit::DefineParam`.| -|[SetParent Method](imetadataemit-setparent-method.md)|Establishes that the specified member, as defined by a prior call to `IMetaDataEmit::DefineMemberRef`, is a member of the specified type, as defined by a prior call to `IMetaDataEmit::DefineTypeDef`.| -|[SetPermissionSetProps Method](imetadataemit-setpermissionsetprops-method.md)|Sets or updates features of the metadata signature of a permission set defined by a prior call to `IMetaDataEmit::DefinePermissionSet`.| -|[SetPinvokeMap Method](imetadataemit-setpinvokemap-method.md)|Sets or changes features of a method's PInvoke signature, as defined by a prior call to `IMetaDataEmit::DefinePinvokeMap`.| -|[SetPropertyProps Method](imetadataemit-setpropertyprops-method.md)|Sets the features stored in metadata for a property defined by a prior call to `IMetaDataEmit::DefineProperty`.| -|[SetRVA Method](imetadataemit-setrva-method.md)|Sets the relative virtual address of the specified method.| -|[SetTypeDefProps Method](imetadataemit-settypedefprops-method.md)|Sets features of a type defined by a prior call to `IMetaDataEmit::DefineTypeDef`.| -|[TranslateSigWithScope Method](imetadataemit-translatesigwithscope-method.md)|Imports an assembly into the current scope and gets a new metadata signature for the merged scope.| - -## Requirements +Provides methods to create, modify, and save metadata about the assembly in the currently defined scope. The metadata can be stored in memory or saved to disk. + +## Methods + +|Method|Description| +|------------|-----------------| +|[ApplyEditAndContinue Method](imetadataemit-applyeditandcontinue-method.md)|Updates the current assembly scope with the changes made in the specified `pImport`.| +|[DefineCustomAttribute Method](imetadataemit-definecustomattribute-method.md)|Creates a definition for a custom attribute with the specified metadata signature, to be attached to the specified object, and gets a token to that custom attribute definition.| +|[DefineEvent Method](imetadataemit-defineevent-method.md)|Creates a definition for an event with the specified metadata signature, and gets a token to that event definition.| +|[DefineField Method](imetadataemit-definefield-method.md)|Creates a definition for a field with the specified metadata signature, and gets a token to that field definition.| +|[DefineImportMember Method](imetadataemit-defineimportmember-method.md)|Creates a definition for a member of a type that is defined in a module outside the current scope, and gets a token for that reference definition.| +|[DefineImportType Method](imetadataemit-defineimporttype-method.md)|Creates a definition for a reference to a type that is defined in a module outside the current scope, and gets a token to that reference definition.| +|[DefineMemberRef Method](imetadataemit-definememberref-method.md)|Creates a definition for a reference to a member of a module outside the current scope, and gets a token to that reference definition.| +|[DefineMethod Method](imetadataemit-definemethod-method.md)|Creates a definition for a method with the specified signature, and returns a token to that method definition.| +|[DefineMethodImpl Method](imetadataemit-definemethodimpl-method.md)|Creates a definition for implementation of a method inherited from an interface, and returns a token to that method-implementation definition.| +|[DefineModuleRef Method](imetadataemit-definemoduleref-method.md)|Creates the metadata signature for a module with the specified name.| +|[DefineNestedType Method](imetadataemit-definenestedtype-method.md)|Creates the metadata signature of a type definition and returns an `mdTypeDef` token for that type, additionally specifying that the defined type is a member of the type referenced by `tdEncloser`.| +|[DefineParam Method](imetadataemit-defineparam-method.md)|Creates a parameter definition with the specified signature for the method referenced by the specified token, and gets a token for that parameter definition.| +|[DefinePermissionSet Method](imetadataemit-definepermissionset-method.md)|Creates a definition for a permission set with the specified metadata signature, and gets a token to that permission set definition.| +|[DefinePinvokeMap Method](imetadataemit-definepinvokemap-method.md)|Sets features of the PInvoke signature of the method referenced by the specified token.| +|[DefineProperty Method](imetadataemit-defineproperty-method.md)|Creates a property definition for the specified type, with the specified `get` and `set` method accessors, and gets a token to that property definition.| +|[DefineSecurityAttributeSet Method](imetadataemit-definesecurityattributeset-method.md)|Creates a set of security permissions to attach to the object referenced by the specified token.| +|[DefineTypeDef Method](imetadataemit-definetypedef-method.md)|Creates a type definition for a common language runtime type, and gets a metadata token to that type definition.| +|[DefineTypeRefByName Method](imetadataemit-definetyperefbyname-method.md)|Gets a metadata token for a type that is defined in another module outside the current scope.| +|[DefineUserString Method](imetadataemit-defineuserstring-method.md)|Gets a metadata token for the specified literal string.| +|[DeleteClassLayout Method](imetadataemit-deleteclasslayout-method.md)|Destroys the class layout metadata signature for the type referenced by the specified token.| +|[DeleteFieldMarshal Method](imetadataemit-deletefieldmarshal-method.md)|Destroys the PInvoke marshalling metadata signature for the object referenced by the specified token.| +|[DeletePinvokeMap Method](imetadataemit-deletepinvokemap-method.md)|Destroys the PInvoke mapping metadata for the object referenced by the specified token.| +|[DeleteToken Method](imetadataemit-deletetoken-method.md)|Deletes the specified token from the current metadata scope.| +|[GetSaveSize Method](imetadataemit-getsavesize-method.md)|Gets the estimated binary size of the assembly in the current scope.| +|[GetTokenFromSig Method](imetadataemit-gettokenfromsig-method.md)|Gets a token for the specified metadata signature.| +|[GetTokenFromTypeSpec Method](imetadataemit-gettokenfromtypespec-method.md)|Gets a metadata token for the type with the specified metadata signature.| +|[Merge Method](imetadataemit-merge-method.md)|Adds the specified imported scope to the list of scopes to be merged.| +|[MergeEnd Method](imetadataemit-mergeend-method.md)|Merges into the current scope all the metadata scopes specified by one or more prior calls to `IMetaDataEmit::Merge`.| +|[Save Method](imetadataemit-save-method.md)|Saves all metadata in the current scope to the file at the specified address.| +|[SaveToMemory Method](imetadataemit-savetomemory-method.md)|Saves all metadata in the current scope to the specified area of memory.| +|[SaveToStream Method](imetadataemit-savetostream-method.md)|Saves all metadata in the current scope to the specified `IStream`.| +|[SetClassLayout Method](imetadataemit-setclasslayout-method.md)|Sets or updates the class layout signature of a type defined by a prior call to `IMetaDataEmit::DefineTypeDef`.| +|[SetCustomAttributeValue Method](imetadataemit-setcustomattributevalue-method.md)|Sets or updates the value of a custom attribute defined by a prior call to `IMetaDataEmit::DefineCustomAttribute`.| +|[SetEventProps Method](imetadataemit-seteventprops-method.md)|Sets or updates the specified feature of an event defined by a prior call to `IMetaDataEmit::DefineEvent`.| +|[SetFieldMarshal Method](imetadataemit-setfieldmarshal-method.md)|Sets the PInvoke marshalling information for the field, method return, or method parameter referenced by the specified token.| +|[SetFieldProps Method](imetadataemit-setfieldprops-method.md)|Sets or updates the default value for the field referenced by the specified field token.| +|[SetFieldRVA Method](imetadataemit-setfieldrva-method.md)|Sets a global variable value for the relative virtual address of the field referenced by the specified token.| +|[SetHandler Method](imetadataemit-sethandler-method.md)|Sets the method referenced by the specified `IUnknown` pointer as a notification callback for token remaps.| +|[SetMethodImplFlags Method](imetadataemit-setmethodimplflags-method.md)|Sets or updates the metadata signature of the inherited method implementation referenced by the specified token.| +|[SetMethodProps Method](imetadataemit-setmethodprops-method.md)|Sets or updates the feature, stored at the specified relative virtual address, of a method defined by a prior call to `IMetaDataEmit::DefineMethod`.| +|[SetModuleProps Method](imetadataemit-setmoduleprops-method.md)|Updates references to a module defined by a prior call to `IMetaDataEmit::DefineModuleRef`.| +|[SetParamProps Method](imetadataemit-setparamprops-method.md)|Sets or changes features of a method parameter that was defined by a prior call to `IMetaDataEmit::DefineParam`.| +|[SetParent Method](imetadataemit-setparent-method.md)|Establishes that the specified member, as defined by a prior call to `IMetaDataEmit::DefineMemberRef`, is a member of the specified type, as defined by a prior call to `IMetaDataEmit::DefineTypeDef`.| +|[SetPermissionSetProps Method](imetadataemit-setpermissionsetprops-method.md)|Sets or updates features of the metadata signature of a permission set defined by a prior call to `IMetaDataEmit::DefinePermissionSet`.| +|[SetPinvokeMap Method](imetadataemit-setpinvokemap-method.md)|Sets or changes features of a method's PInvoke signature, as defined by a prior call to `IMetaDataEmit::DefinePinvokeMap`.| +|[SetPropertyProps Method](imetadataemit-setpropertyprops-method.md)|Sets the features stored in metadata for a property defined by a prior call to `IMetaDataEmit::DefineProperty`.| +|[SetRVA Method](imetadataemit-setrva-method.md)|Sets the relative virtual address of the specified method.| +|[SetTypeDefProps Method](imetadataemit-settypedefprops-method.md)|Sets features of a type defined by a prior call to `IMetaDataEmit::DefineTypeDef`.| +|[TranslateSigWithScope Method](imetadataemit-translatesigwithscope-method.md)|Imports an assembly into the current scope and gets a new metadata signature for the merged scope.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-merge-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md similarity index 55% rename from docs/framework/unmanaged-api/metadata/imetadataemit-merge-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md index 54ac2beb11454..bed96413485d4 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-merge-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataEmit::Merge Method" title: "IMetaDataEmit::Merge Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.Merge" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::Merge" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::Merge method [.NET Framework metadata]" - "Merge method [.NET Framework metadata]" -ms.assetid: 7596220c-f699-4b6c-8ae7-c83220610650 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::Merge Method -Adds the specified imported scope to the list of scopes to be merged. - -## Syntax - -```cpp +Adds the specified imported scope to the list of scopes to be merged. + +## Syntax + +```cpp HRESULT Merge ( [in] IMetaDataImport *pImport, [in] IMapToken *pHostMapToken, [in] IUnknown *pHandler -); -``` - -## Parameters - - `pImport` - [in] A pointer to an [IMetaDataImport](imetadataimport-interface.md) object that identifies the imported scope to be merged. - - `pIMap` - [in] A pointer to an [IMapToken](imaptoken-interface.md) object that specifies the token re-map. - - `pHandler` - [in] A pointer to an [IUnknown](/cpp/atl/iunknown) object that specifies the errors. - -## Remarks - - Call [IMetaDataEmit::MergeEnd](imetadataemit-mergeend-method.md) to trigger the merger of metadata into a single scope. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `pImport` + [in] A pointer to an [IMetaDataImport](imetadataimport-interface.md) object that identifies the imported scope to be merged. + + `pIMap` + [in] A pointer to an [IMapToken](imaptoken-interface.md) object that specifies the token re-map. + + `pHandler` + [in] A pointer to an [IUnknown](/cpp/atl/iunknown) object that specifies the errors. + +## Remarks + + Call [IMetaDataEmit::MergeEnd](imetadataemit-mergeend-method.md) to trigger the merger of metadata into a single scope. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-mergeend-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md similarity index 94% rename from docs/framework/unmanaged-api/metadata/imetadataemit-mergeend-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md index 9f4bcd31b5dbf..bd44b29361e1a 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-mergeend-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "MergeEnd method [.NET Framework metadata]" - "IMetaDataEmit::MergeEnd method [.NET Framework metadata]" -ms.assetid: 2d64315a-1af1-4c60-aedf-f8a781914aea topic_type: - "apiref" --- @@ -59,13 +58,13 @@ The following special conditions apply to the merge: ## Requirements -**Platforms:** See [System Requirements](../../get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h **Library:** Used as a resource in MSCorEE.dll -**.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] +**.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] ## See also diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-save-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataemit-save-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-save-method.md index 59ca6c58b08c1..d2b02994cb53d 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-save-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit::Save Method" title: "IMetaDataEmit::Save Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.Save" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::Save" -helpviewer_keywords: +helpviewer_keywords: - "Save method, IMetaDataEmit interface [.NET Framework metadata]" - "IMetaDataEmit::Save method [.NET Framework metadata]" -ms.assetid: c1de8400-adfe-4a71-b828-a1d0cc1ea505 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::Save Method -Saves all metadata in the current scope to the file at the specified address. - -## Syntax - -```cpp +Saves all metadata in the current scope to the file at the specified address. + +## Syntax + +```cpp HRESULT Save ( [in] LPCWSTR szFile, - [in] DWORD dwSaveFlags -); -``` - -## Parameters - - `wzFile` - [in] The name of the file to save to. If this value is null, the in-memory copy will be saved to the last location that was used. - - `dwSaveFlags` - [in] Reserved. Must be zero. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] DWORD dwSaveFlags +); +``` + +## Parameters + + `wzFile` + [in] The name of the file to save to. If this value is null, the in-memory copy will be saved to the last location that was used. + + `dwSaveFlags` + [in] Reserved. Must be zero. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-savetomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataemit-savetomemory-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md index dcbeee27cf930..cbd3b7c2c51de 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-savetomemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit::SaveToMemory Method" title: "IMetaDataEmit::SaveToMemory Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SaveToMemory" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SaveToMemory" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SaveToMemory method [.NET Framework metadata]" - "SaveToMemory method [.NET Framework metadata]" -ms.assetid: d5237628-2675-45ed-a39e-65c0731b6a56 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SaveToMemory Method -Saves all metadata in the current scope to the specified area of memory. - -## Syntax - -```cpp +Saves all metadata in the current scope to the specified area of memory. + +## Syntax + +```cpp HRESULT SaveToMemory ( [out] void *pbData, [in] ULONG cbData -); -``` - -## Parameters - - `pbData` - [out] The address at which to begin writing metadata. - - `cbData` - [in] The size, in bytes, of the allocated memory. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `pbData` + [out] The address at which to begin writing metadata. + + `cbData` + [in] The size, in bytes, of the allocated memory. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md new file mode 100644 index 0000000000000..c16afdcb143ec --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataEmit::SaveToStream Method" +title: "IMetaDataEmit::SaveToStream Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit.SaveToStream" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit::SaveToStream" +helpviewer_keywords: + - "IMetaDataEmit::SaveToStream method [.NET Framework metadata]" + - "SaveToStream method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit::SaveToStream Method + +Saves all metadata in the current scope to the specified `IStream`. + +## Syntax + +```cpp +HRESULT SaveToStream ( + [in] IStream *pIStream, + [in] DWORD dwSaveFlags +); +``` + +## Parameters + + `pIStream` + [in] The writable stream to save to. + + `dwSaveFlags` + [in] Reserved. Must be zero. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataEmit Interface](imetadataemit-interface.md) +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md similarity index 68% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md index 14fecc45baeea..c899c30918228 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md @@ -2,70 +2,69 @@ description: "Learn more about: IMetaDataEmit::SetClassLayout Method" title: "IMetaDataEmit::SetClassLayout Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetClassLayout" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetClassLayout" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SetClassLayout method [.NET Framework metadata]" - "SetClassLayout method [.NET Framework metadata]" -ms.assetid: 2576c449-388d-4434-a0e1-9f53991e11b6 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetClassLayout Method -Completes the layout of fields for a class that has been defined by a prior call to [DefineTypeDef Method](imetadataemit-definetypedef-method.md). - -## Syntax - -```cpp -HRESULT SetClassLayout ( +Completes the layout of fields for a class that has been defined by a prior call to [DefineTypeDef Method](imetadataemit-definetypedef-method.md). + +## Syntax + +```cpp +HRESULT SetClassLayout ( [in] mdTypeDef td, [in] DWORD dwPackSize, [in] COR_FIELD_OFFSET rFieldOffsets[], [in] ULONG ulClassSize -); -``` - -## Parameters - - `td` - [in] An `mdTypeDef` token that specifies the class to be laid out. - - `dwPackSize` - [in] The packing size: 1, 2, 4, 8 or 16 bytes. The packing size is the number of bytes between adjacent fields. - - `rFieldOffsets` - [in] An array of [COR_FIELD_OFFSET](cor-field-offset-structure.md) structures, each of which specifies a field of the class and the field's offset within the class. Terminate the array with `mdTokenNil`. - - `ulClassSize` - [in] The size, in bytes, of the class. - -## Remarks - - The class is initially defined by calling the [IMetaDataEmit::DefineTypeDef](imetadataemit-definetypedef-method.md) method, and specifying one of three layouts for the fields of the class: automatic, sequential, or explicit. Normally, you would use automatic layout and let the runtime choose the best way to lay out the fields. - - However, you might want the fields laid out according to the arrangement that unmanaged code uses. In this case, choose either sequential or explicit layout and call `SetClassLayout` to complete the layout of the fields: - -- Sequential layout: Specify the packing size. A field is aligned according to either its natural size or the packing size, whichever results in the smaller offset of the field. Set `rFieldOffsets` and `ulClassSize` to zero. - -- Explicit layout: Either specify the offset of each field or specify the class size and the packing size. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `td` + [in] An `mdTypeDef` token that specifies the class to be laid out. + + `dwPackSize` + [in] The packing size: 1, 2, 4, 8 or 16 bytes. The packing size is the number of bytes between adjacent fields. + + `rFieldOffsets` + [in] An array of [COR_FIELD_OFFSET](cor-field-offset-structure.md) structures, each of which specifies a field of the class and the field's offset within the class. Terminate the array with `mdTokenNil`. + + `ulClassSize` + [in] The size, in bytes, of the class. + +## Remarks + + The class is initially defined by calling the [IMetaDataEmit::DefineTypeDef](imetadataemit-definetypedef-method.md) method, and specifying one of three layouts for the fields of the class: automatic, sequential, or explicit. Normally, you would use automatic layout and let the runtime choose the best way to lay out the fields. + + However, you might want the fields laid out according to the arrangement that unmanaged code uses. In this case, choose either sequential or explicit layout and call `SetClassLayout` to complete the layout of the fields: + +- Sequential layout: Specify the packing size. A field is aligned according to either its natural size or the packing size, whichever results in the smaller offset of the field. Set `rFieldOffsets` and `ulClassSize` to zero. + +- Explicit layout: Either specify the offset of each field or specify the class size and the packing size. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md similarity index 58% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md index cd4bea2797d25..d0b6b74111ba2 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataEmit::SetCustomAttributeValue Method" title: "IMetaDataEmit::SetCustomAttributeValue Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetCustomAttributeValue" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetCustomAttributeValue" -helpviewer_keywords: +helpviewer_keywords: - "SetCustomAttributeValue method [.NET Framework metadata]" - "IMetaDataEmit::SetCustomAttributeValue method [.NET Framework metadata]" -ms.assetid: f721c863-9642-4e64-917a-65f9e55c25b9 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetCustomAttributeValue Method -Sets or updates the value of a custom attribute defined by a prior call to [IMetaDataEmit::DefineCustomAttribute](imetadataemit-definecustomattribute-method.md). - -## Syntax - -```cpp +Sets or updates the value of a custom attribute defined by a prior call to [IMetaDataEmit::DefineCustomAttribute](imetadataemit-definecustomattribute-method.md). + +## Syntax + +```cpp HRESULT SetCustomAttributeValue ( [in] mdCustomAttribute pcv, [in] void const *pCustomAttribute, [in] ULONG cbCustomAttribute -); -``` - -## Parameters - - `pcv` - [in] The token of the target custom attribute. - - `pCustomAttribute` - [in] A pointer to the array that contains the custom attribute. - - `cbCustomAttribute` - [in] The size, in bytes, of the custom attribute. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `pcv` + [in] The token of the target custom attribute. + + `pCustomAttribute` + [in] A pointer to the array that contains the custom attribute. + + `cbCustomAttribute` + [in] The size, in bytes, of the custom attribute. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-seteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataemit-seteventprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md index b9ea937ff0d28..b7a091ad12956 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-seteventprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md @@ -2,29 +2,28 @@ description: "Learn more about: IMetaDataEmit::SetEventProps Method" title: "IMetaDataEmit::SetEventProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetEventProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetEventProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SetEventProps method [.NET Framework metadata]" - "SetEventProps method [.NET Framework metadata]" -ms.assetid: 3b039e50-63ec-4730-99ff-2327408de477 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetEventProps Method -Sets or updates the specified feature of an event defined by a prior call to [IMetaDataEmit::DefineEvent](imetadataemit-defineevent-method.md). - -## Syntax - -```cpp -HRESULT SetEventProps ( +Sets or updates the specified feature of an event defined by a prior call to [IMetaDataEmit::DefineEvent](imetadataemit-defineevent-method.md). + +## Syntax + +```cpp +HRESULT SetEventProps ( [in] mdEvent ev, [in] DWORD dwEventFlags, [in] mdToken tkEventType, @@ -32,42 +31,42 @@ HRESULT SetEventProps ( [in] mdMethodDef mdRemoveOn, [in] mdMethodDef mdFire, [in] mdMethodDef rmdOtherMethods[] -); -``` - -## Parameters - - `ev` - [in] The event token. - - `dwEventFlags` - [in] Event flags. This is a bitmask of `CorEventAttr` values. - - `tkEventType` - [in] The token for the event class. This is either a `mdTypeDef` or a `mdTypeRef` token. - - `mdAddOn` - [in] The method used to subscribe to the event, or null. - - `mdRemoveOn` - [in] The method used to unsubscribe to the event, or null. - - `mdFire` - [in] The method used (by a derived class) to raise the event. - - `rmdOtherMethods[]` - [in] An array of tokens for other methods associated with the event. The last element of the array must be `mdMethodDefNil`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `ev` + [in] The event token. + + `dwEventFlags` + [in] Event flags. This is a bitmask of `CorEventAttr` values. + + `tkEventType` + [in] The token for the event class. This is either a `mdTypeDef` or a `mdTypeRef` token. + + `mdAddOn` + [in] The method used to subscribe to the event, or null. + + `mdRemoveOn` + [in] The method used to unsubscribe to the event, or null. + + `mdFire` + [in] The method used (by a derived class) to raise the event. + + `rmdOtherMethods[]` + [in] An array of tokens for other methods associated with the event. The last element of the array must be `mdMethodDefNil`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md index 2a65b79c400f1..1dda9a749a081 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataEmit::SetFieldMarshal Method" title: "IMetaDataEmit::SetFieldMarshal Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetFieldMarshal" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetFieldMarshal" -helpviewer_keywords: +helpviewer_keywords: - "SetFieldMarshal method [.NET Framework metadata]" - "IMetaDataEmit::SetFieldMarshal method [.NET Framework metadata]" -ms.assetid: be232314-7f69-4855-bfab-63361bd22307 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetFieldMarshal Method -Sets the PInvoke marshalling information for the field, method return, or method parameter referenced by the specified token. - -## Syntax - -```cpp -HRESULT SetFieldMarshal ( +Sets the PInvoke marshalling information for the field, method return, or method parameter referenced by the specified token. + +## Syntax + +```cpp +HRESULT SetFieldMarshal ( [in] mdToken tk, [in] PCCOR_SIGNATURE pvNativeType, [in] ULONG cbNativeType -); -``` - -## Parameters - - `tk` - [in] The token for target data item. This is either a `mdFieldDef` or a `mdParamDef` token. - - `pvNativeType` - [in] The signature for unmanaged type. - - `cbNativeType` - [in] The count of bytes in `pvNativeType`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tk` + [in] The token for target data item. This is either a `mdFieldDef` or a `mdParamDef` token. + + `pvNativeType` + [in] The signature for unmanaged type. + + `cbNativeType` + [in] The count of bytes in `pvNativeType`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md index 118f4ebfbcc50..3283cb7448c25 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataEmit::SetFieldProps Method" title: "IMetaDataEmit::SetFieldProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetFieldProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetFieldProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SetFieldProps method [.NET Framework metadata]" - "SetFieldProps method [.NET Framework metadata]" -ms.assetid: 47132dda-fa92-4bd1-ae4b-24cd9a60665a -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetFieldProps Method -Sets or updates the default value for the field referenced by the specified field token. - -## Syntax - -```cpp -HRESULT SetFieldProps ( +Sets or updates the default value for the field referenced by the specified field token. + +## Syntax + +```cpp +HRESULT SetFieldProps ( [in] mdFieldDef fd, [in] DWORD dwFieldFlags, [in] DWORD dwCPlusTypeFlag, [in] void const *pValue, [in] ULONG cchValue -); -``` - -## Parameters - - `fd` - [in] The token for the target field. - - `dwFieldFlags` - [in] Field attributes. This is a bitmask of `CorFieldAttr` values. - - `dwCPlusTypeFlag` - [in] The `ELEMENT_TYPE_`*\** for the constant value. This is a `CorElementType` value. If a constant is not being defined, set this value to `ELEMENT_TYPE_END`. - - `pValue` - [in] The constant value for the field. - - `cchValue` - [in] The size, in Unicode characters, of `pValue`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `fd` + [in] The token for the target field. + + `dwFieldFlags` + [in] Field attributes. This is a bitmask of `CorFieldAttr` values. + + `dwCPlusTypeFlag` + [in] The `ELEMENT_TYPE_`*\** for the constant value. This is a `CorElementType` value. If a constant is not being defined, set this value to `ELEMENT_TYPE_END`. + + `pValue` + [in] The constant value for the field. + + `cchValue` + [in] The size, in Unicode characters, of `pValue`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md index 1a0efb5be1247..7fab0a0d78dfc 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit::SetFieldRVA Method" title: "IMetaDataEmit::SetFieldRVA Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetFieldRVA" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetFieldRVA" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SetFieldRVA method [.NET Framework metadata]" - "SetFieldRVA method [.NET Framework metadata]" -ms.assetid: 6dc37f9d-87ee-4cb3-9216-ced600184ce8 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetFieldRVA Method -Sets a global variable value for the relative virtual address of the field referenced by the specified token. - -## Syntax - -```cpp +Sets a global variable value for the relative virtual address of the field referenced by the specified token. + +## Syntax + +```cpp HRESULT SetFieldRVA ( [in] mdFieldDef fd, [in] ULONG ulRVA -); -``` - -## Parameters - - `fd` - [in] The token for the target field. - - `ulRVA` - [in] The address of a code or data area. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `fd` + [in] The token for the target field. + + `ulRVA` + [in] The address of a code or data area. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-sethandler-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md similarity index 60% rename from docs/framework/unmanaged-api/metadata/imetadataemit-sethandler-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md index b8f8bc357b47b..b94669fdde392 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-sethandler-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md @@ -2,54 +2,53 @@ description: "Learn more about: IMetaDataEmit::SetHandler Method" title: "IMetaDataEmit::SetHandler Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetHandler" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetHandler" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SetHandler method [.NET Framework metadata]" - "SetHandler method [.NET Framework metadata]" -ms.assetid: c6c1aaaf-e2cd-407c-b73e-fbe6ffd83bb3 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetHandler Method -Sets the method referenced by the specified `IUnknown` pointer as a notification callback for token remaps. - -## Syntax - -```cpp +Sets the method referenced by the specified `IUnknown` pointer as a notification callback for token remaps. + +## Syntax + +```cpp HRESULT SetHandler ( - [in] IUnknown *pUnk -); -``` - -## Parameters - - `pUnk` - [in] The handler to register. - -## Remarks - - The metadata engine sends notification by using the method that is provided by `SetHandler`, to compilers that do not generate records in an optimized way and that would like to optimize saved records. - - If the callback method is not provided through `SetHandler`, no optimization will be performed on save except where several import scopes have been merged using `IMapToken` on merge for each scope. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] IUnknown *pUnk +); +``` + +## Parameters + + `pUnk` + [in] The handler to register. + +## Remarks + + The metadata engine sends notification by using the method that is provided by `SetHandler`, to compilers that do not generate records in an optimized way and that would like to optimize saved records. + + If the callback method is not provided through `SetHandler`, no optimization will be performed on save except where several import scopes have been merged using `IMapToken` on merge for each scope. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md similarity index 56% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md index 64e2bb1b7d091..44730ef0c1c7f 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit::SetMethodImplFlags Method" title: "IMetaDataEmit::SetMethodImplFlags Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetMethodImplFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetMethodImplFlags" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SetMethodImplFlags method [.NET Framework metadata]" - "SetMethodImpFlags method [.NET Framework metadata]" -ms.assetid: 4bc82d9b-9544-4be3-ba51-a2d4d806158a -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetMethodImplFlags Method -Sets or updates the metadata signature of the inherited method implementation that is referenced by the specified token. - -## Syntax - -```cpp +Sets or updates the metadata signature of the inherited method implementation that is referenced by the specified token. + +## Syntax + +```cpp HRESULT SetMethodImplFlags ( [in] mdMethodDef md, [in] DWORD dwImplFlags -); -``` - -## Parameters - - `md` - [in] The token for the method to be changed. - - `dwImplFlags` - [in] A combination of the values of the [CorMethodImpl](cormethodimpl-enumeration.md) enumeration that specifies the method implementation features. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `md` + [in] The token for the method to be changed. + + `dwImplFlags` + [in] A combination of the values of the [CorMethodImpl](cormethodimpl-enumeration.md) enumeration that specifies the method implementation features. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md new file mode 100644 index 0000000000000..0740583872df5 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md @@ -0,0 +1,61 @@ +--- +description: "Learn more about: IMetaDataEmit::SetMethodProps Method" +title: "IMetaDataEmit::SetMethodProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit.SetMethodProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit::SetMethodProps" +helpviewer_keywords: + - "SetMethodProps method [.NET Framework metadata]" + - "IMetaDataEmit::SetMethodProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit::SetMethodProps Method + +Sets or updates the feature, stored at the specified relative virtual address, of a method defined by a prior call to [IMetaDataEmit::DefineMethod](imetadataemit-definemethod-method.md). + +## Syntax + +```cpp +HRESULT SetMethodProps ( + [in] mdMethodDef md, + [in] DWORD dwMethodFlags, + [in] ULONG ulCodeRVA, + [in] DWORD dwImplFlags +); +``` + +## Parameters + + `md` + [in] The token for the method to be changed. + + `dwMethodFlags` + [in] The member attributes. + + `ulCodeRVA` + [in] The address of the code. + + `dwImplFlags` + [in] The implementation flags for the method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataEmit Interface](imetadataemit-interface.md) +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md similarity index 57% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md index 6bee43cc3fecf..1abc568960b6e 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataEmit::SetModuleProps Method" title: "IMetaDataEmit::SetModuleProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetModuleProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetModuleProps" -helpviewer_keywords: +helpviewer_keywords: - "SetModuleProps method [.NET Framework metadata]" - "IMetaDataEmit::SetModuleProps method [.NET Framework metadata]" -ms.assetid: b74d7629-5f46-458f-8d67-2456a1e7030c -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetModuleProps Method -Updates references to a module defined by a prior call to [IMetaDataEmit::DefineModuleRef](imetadataemit-definemoduleref-method.md). - -## Syntax - -```cpp +Updates references to a module defined by a prior call to [IMetaDataEmit::DefineModuleRef](imetadataemit-definemoduleref-method.md). + +## Syntax + +```cpp HRESULT SetModuleProps ( - [in] LPCWSTR szName -); -``` - -## Parameters - - `szName` - [in] The module name in Unicode. This is the file name only and not the full path name. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] LPCWSTR szName +); +``` + +## Parameters + + `szName` + [in] The module name in Unicode. This is the file name only and not the full path name. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md new file mode 100644 index 0000000000000..59d9e87b80960 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md @@ -0,0 +1,69 @@ +--- +description: "Learn more about: IMetaDataEmit::SetParamProps Method" +title: "IMetaDataEmit::SetParamProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit.SetParamProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit::SetParamProps" +helpviewer_keywords: + - "IMetaDataEmit::SetParamProps method [.NET Framework metadata]" + - "SetParamProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit::SetParamProps Method + +Sets or changes features of a method parameter that was defined by a prior call to [IMetaDataEmit::DefineParam](imetadataemit-defineparam-method.md). + +## Syntax + +```cpp +HRESULT SetParamProps ( + [in] mdParamDef pd, + [in] LPCWSTR szName, + [in] DWORD dwParamFlags, + [in] DWORD dwCPlusTypeFlag, + [in] void const *pValue, + [in] ULONG cchValue +); +``` + +## Parameters + + `pd` + [in] The token for the target parameter. + + `szName` + [in] The name of the parameter in Unicode. + + `dwParamFlags` + [in] The flags for the parameter. + + `dwCPlusTypeFlag` + [in] The ELEMENT_TYPE_* for the constant value. + + `pValue` + [in] The constant value for the parameter. + + `cchValue` + [in] The size in (Unicode) characters of `pValue`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataEmit Interface](imetadataemit-interface.md) +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setparent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md similarity index 56% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setparent-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md index 3f42da6f91465..144650594a874 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setparent-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit::SetParent Method" title: "IMetaDataEmit::SetParent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetParent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetParent" -helpviewer_keywords: +helpviewer_keywords: - "SetParent method [.NET Framework metadata]" - "IMetaDataEmit::SetParent method [.NET Framework metadata]" -ms.assetid: 02a02ff7-ae0e-4692-a20e-372405f23052 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetParent Method -Establishes that the specified member, as defined by a prior call to [IMetaDataEmit::DefineMemberRef](imetadataemit-definememberref-method.md), is a member of the specified type, as defined by a prior call to [IMetaDataEmit::DefineTypeDef](imetadataemit-definetypedef-method.md). - -## Syntax - -```cpp +Establishes that the specified member, as defined by a prior call to [IMetaDataEmit::DefineMemberRef](imetadataemit-definememberref-method.md), is a member of the specified type, as defined by a prior call to [IMetaDataEmit::DefineTypeDef](imetadataemit-definetypedef-method.md). + +## Syntax + +```cpp HRESULT SetParent ( [in] mdMemberRef mr, [in] mdToken tk -); -``` - -## Parameters - - `mr` - [in] The `mdMemberRef` token to receive a new parent. - - `tk` - [in] The `mdToken` for the new parent. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `mr` + [in] The `mdMemberRef` token to receive a new parent. + + `tk` + [in] The `mdToken` for the new parent. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md similarity index 58% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md index 5e61399647dbc..896c6cf2b9945 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataEmit::SetPermissionSetProps Method" title: "IMetaDataEmit::SetPermissionSetProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetPermissionSetProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetPermissionSetProps" -helpviewer_keywords: +helpviewer_keywords: - "SetPermissionSetProps method [.NET Framework metadata]" - "IMetaDataEmit::SetPermissionSetProps method [.NET Framework metadata]" -ms.assetid: 8eaee971-40bf-45e2-a3d8-6e57674213b6 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetPermissionSetProps Method -Sets or updates features of the metadata signature of a permission set defined by a prior call to [IMetaDataEmit::DefinePermissionSet](imetadataemit-definepermissionset-method.md). - -## Syntax - -```cpp +Sets or updates features of the metadata signature of a permission set defined by a prior call to [IMetaDataEmit::DefinePermissionSet](imetadataemit-definepermissionset-method.md). + +## Syntax + +```cpp HRESULT SetPermissionSetProps ( [in] mdToken tk, [in] DWORD dwAction, [in] void const *pvPermission, [in] ULONG cbPermission, [out] mdPermission *ppm -); -``` - -## Parameters - - `tk` - [in] A metadata token that represents the object to be decorated. - - `dwAction` - [in] A [CorDeclSecurity](cordeclsecurity-enumeration.md) value that specifies the type of declarative security to be used. - - `pvPermission` - [in] The permission BLOB. - - `cbPermission` - [in] The size, in bytes, of `pvPermission`. - - `ppm` - [out] An `mdPermission` metadata token that represents the updated permissions. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tk` + [in] A metadata token that represents the object to be decorated. + + `dwAction` + [in] A [CorDeclSecurity](cordeclsecurity-enumeration.md) value that specifies the type of declarative security to be used. + + `pvPermission` + [in] The permission BLOB. + + `cbPermission` + [in] The size, in bytes, of `pvPermission`. + + `ppm` + [out] An `mdPermission` metadata token that represents the updated permissions. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md index 7720ca3fa1935..9ca9bf1e48806 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataEmit::SetPinvokeMap Method" title: "IMetaDataEmit::SetPinvokeMap Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetPinvokeMap" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetPinvokeMap" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SetPinvokeMap method [.NET Framework metadata]" - "SetPinvokeMap method [.NET Framework metadata]" -ms.assetid: c6bfd574-1da3-4ba7-82f2-46ca5efcbaba -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetPinvokeMap Method -Sets or changes features of a method's PInvoke signature, as defined by a prior call to [IMetaDataEmit::DefinePinvokeMap](imetadataemit-definepinvokemap-method.md). - -## Syntax - -```cpp +Sets or changes features of a method's PInvoke signature, as defined by a prior call to [IMetaDataEmit::DefinePinvokeMap](imetadataemit-definepinvokemap-method.md). + +## Syntax + +```cpp HRESULT SetPinvokeMap ( [in] mdToken tk, - [in] DWORD dwMappingFlags, + [in] DWORD dwMappingFlags, [in] LPCWSTR szImportName, [in] mdModuleRef mrImportDLL -); -``` - -## Parameters - - `tk` - [in] The `mdToken` to which mapping information applies. - - `dwMappingFlags` - [in] Flags used by PInvoke to do the mapping. This is a bitmask of `CorPinvokeMap` values. - - `szImportName` - [in] The name of the target export in the native DLL. - - `mrImportDLL` - [in] The `mdModuleRef` token for the target unmanaged DLL. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tk` + [in] The `mdToken` to which mapping information applies. + + `dwMappingFlags` + [in] Flags used by PInvoke to do the mapping. This is a bitmask of `CorPinvokeMap` values. + + `szImportName` + [in] The name of the target export in the native DLL. + + `mrImportDLL` + [in] The `mdModuleRef` token for the target unmanaged DLL. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md index 286daea793894..eafa18a4c3614 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md @@ -2,28 +2,27 @@ description: "Learn more about: IMetaDataEmit::SetPropertyProps Method" title: "IMetaDataEmit::SetPropertyProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetPropertyProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetPropertyProps" -helpviewer_keywords: +helpviewer_keywords: - "SetPropertyProps method [.NET Framework metadata]" - "IMetaDataEmit::SetPropertyProps method [.NET Framework metadata]" -ms.assetid: e2501fc8-b2bc-4dcc-9205-e3acd5a53ffe -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetPropertyProps Method -Sets the features stored in metadata for a property defined by a prior call to [DefineProperty Method](imetadataemit-defineproperty-method.md). - -## Syntax - -```cpp +Sets the features stored in metadata for a property defined by a prior call to [DefineProperty Method](imetadataemit-defineproperty-method.md). + +## Syntax + +```cpp HRESULT SetPropertyProps ( [in] mdProperty pr, [in] DWORD dwPropFlags, @@ -33,45 +32,45 @@ HRESULT SetPropertyProps ( [in] mdMethodDef mdSetter, [in] mdMethodDef mdGetter, [in] mdMethodDef rmdOtherMethods[] -); -``` - -## Parameters - - `pr` - [in] The token for the property to be changed - - `dwPropFlags` - [in] Property flags. - - `dwCPlusTypeFlag` - [in] The type of the property's default value. - - `pValue` - [in] The default value for the property. - - `cchValue` - [in] The count of (Unicode) characters in `pValue`. - - `mdSetter` - [in] The method that sets the property value. - - `mdGetter` - [in] The method that gets the property value. - - `rmdOtherMethods[]` - [in] An array of other methods associated with the property. Terminate this array with an `mdTokenNil` token. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `pr` + [in] The token for the property to be changed + + `dwPropFlags` + [in] Property flags. + + `dwCPlusTypeFlag` + [in] The type of the property's default value. + + `pValue` + [in] The default value for the property. + + `cchValue` + [in] The count of (Unicode) characters in `pValue`. + + `mdSetter` + [in] The method that sets the property value. + + `mdGetter` + [in] The method that gets the property value. + + `rmdOtherMethods[]` + [in] An array of other methods associated with the property. Terminate this array with an `mdTokenNil` token. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md new file mode 100644 index 0000000000000..a54ab023f1e1e --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataEmit::SetRVA Method" +title: "IMetaDataEmit::SetRVA Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit.SetRVA" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit::SetRVA" +helpviewer_keywords: + - "IMetaDataEmit::SetRVA method [.NET Framework metadata]" + - "SetRVA method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit::SetRVA Method + +Sets the relative virtual address of the specified method. + +## Syntax + +```cpp +HRESULT SetRVA ( + [in] mdMethodDef md, + [in] ULONG ulRVA +); +``` + +## Parameters + + `md` + [in] The token for the target method or method implementation. + + `ulRVA` + [in] The address of the code or data area. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataEmit Interface](imetadataemit-interface.md) +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md similarity index 62% rename from docs/framework/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md index 631792b3a3492..1fe52495d0f5a 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataEmit::SetTypeDefProps Method" title: "IMetaDataEmit::SetTypeDefProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetTypeDefProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetTypeDefProps" -helpviewer_keywords: +helpviewer_keywords: - "SetTypeDefProps method [.NET Framework metadata]" - "IMetaDataEmit::SetTypeDefProps method [.NET Framework metadata]" -ms.assetid: 480d596a-759f-4d29-ac1a-3dbff8f3544d -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetTypeDefProps Method -Sets features of a type defined by a prior call to [IMetaDataEmit::DefineTypeDef](imetadataemit-definetypedef-method.md). - -## Syntax - -```cpp -HRESULT SetTypeDefProps ( +Sets features of a type defined by a prior call to [IMetaDataEmit::DefineTypeDef](imetadataemit-definetypedef-method.md). + +## Syntax + +```cpp +HRESULT SetTypeDefProps ( [in] mdTypeDef td, [in] DWORD dwTypeDefFlags, [in] mdToken tkExtends, [in] mdToken rtkImplements[] -); -``` - -## Parameters - - `td` - [in] An `mdTypeDef` token obtained from original call to [IMetaDataEmit::DefineTypeDef](imetadataemit-definetypedef-method.md). - - `dwTypeDefFlags` - [in] `TypeDef` attributes. This is a bitmask of `CorTypeAttr` values. - - `tkExtends` - [in] The `mdToken` of the base class. Obtained from a previous call to [IMetaDataEmit::DefineImportType](imetadataemit-defineimporttype-method.md), or `null`. - - `rtkImplements[]` - [in] An array of tokens for the interfaces that this type implements. These `mdTypeRef` tokens are obtained using [IMetaDataEmit::DefineImportType](imetadataemit-defineimporttype-method.md). The last element of the array is must be `mdTokenNil`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `td` + [in] An `mdTypeDef` token obtained from original call to [IMetaDataEmit::DefineTypeDef](imetadataemit-definetypedef-method.md). + + `dwTypeDefFlags` + [in] `TypeDef` attributes. This is a bitmask of `CorTypeAttr` values. + + `tkExtends` + [in] The `mdToken` of the base class. Obtained from a previous call to [IMetaDataEmit::DefineImportType](imetadataemit-defineimporttype-method.md), or `null`. + + `rtkImplements[]` + [in] An array of tokens for the interfaces that this type implements. These `mdTypeRef` tokens are obtained using [IMetaDataEmit::DefineImportType](imetadataemit-defineimporttype-method.md). The last element of the array is must be `mdTokenNil`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md index 17db5839d96f1..2e79601e9aee0 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md @@ -2,88 +2,87 @@ description: "Learn more about: IMetaDataEmit::TranslateSigWithScope Method" title: "IMetaDataEmit::TranslateSigWithScope Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.TranslateSigWithScope" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::TranslateSigWithScope" -helpviewer_keywords: +helpviewer_keywords: - "TranslateSigWithScope method [.NET Framework metadata]" - "IMetaDataEmit::TranslateSigWithScope method [.NET Framework metadata]" -ms.assetid: 47915d33-b7bf-409e-b484-4ee1df15de22 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::TranslateSigWithScope Method -Imports an assembly into the current scope and gets a new metadata signature for the merged scope. - -## Syntax - -```cpp +Imports an assembly into the current scope and gets a new metadata signature for the merged scope. + +## Syntax + +```cpp HRESULT TranslateSigWithScope ( [in] IMetaDataAssemblyImport *pAssemImport, [in] const void *pbHashValue, [in] ULONG cbHashValue, [in] IMetaDataImport *import, [in] PCCOR_SIGNATURE pbSigBlob, - [in] ULONG cbSigBlob, + [in] ULONG cbSigBlob, [in] IMetaDataAssemblyEmit *pAssemEmit, [in] IMetaDataEmit *emit, [out] PCOR_SIGNATURE pvTranslatedSig, [in] ULONG cbTranslatedSigMax, [out] ULONG *pcbTranslatedSig -); -``` - -## Parameters - - `pAssemImport` - [in] The interface for import assembly (where the signature is defined). - - `pbHashValue` - [in] The hash blob for the assembly. - - `cbHashValue` - [in] The count of bytes in `pbHashValue`. - - `import` - [in] The interface for import metadata scope. - - `pbSigBlob` - [in] The signature to be imported. - - `cbSigBlob` - [in] The size, in bytes, of `pbSigBlob`. - - `pAssemEmit` - [in] The interface for export assembly. - - `emit` - [in] The interface for export metadata scope. - - `pvTranslatedSig` - [out] The buffer to hold the translated signature blob. - - `cbTranslatedSigMax` - [in] The capacity, in bytes, of `pvTranslatedSig`. - - `pcbTranslatedSig` - [out] The number of actual bytes in the translated signature. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `pAssemImport` + [in] The interface for import assembly (where the signature is defined). + + `pbHashValue` + [in] The hash blob for the assembly. + + `cbHashValue` + [in] The count of bytes in `pbHashValue`. + + `import` + [in] The interface for import metadata scope. + + `pbSigBlob` + [in] The signature to be imported. + + `cbSigBlob` + [in] The size, in bytes, of `pbSigBlob`. + + `pAssemEmit` + [in] The interface for export assembly. + + `emit` + [in] The interface for export metadata scope. + + `pvTranslatedSig` + [out] The buffer to hold the translated signature blob. + + `cbTranslatedSigMax` + [in] The capacity, in bytes, of `pvTranslatedSig`. + + `pcbTranslatedSig` + [out] The number of actual bytes in the translated signature. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md similarity index 55% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md index 28dfc9222b810..5e04036094750 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md @@ -2,28 +2,27 @@ description: "Learn more about: IMetaDataEmit2::DefineGenericParam Method" title: "IMetaDataEmit2::DefineGenericParam Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit2.DefineGenericParam" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit2::DefineGenericParam" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit2::DefineGenericParam method [.NET Framework metadata]" - "DefineGenericParam method [.NET Framework metadata]" -ms.assetid: 47b2a3b6-907d-43dc-858d-1ae7dca1316a -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit2::DefineGenericParam Method -Creates a definition for a generic type parameter, and gets a token to that generic type parameter. - -## Syntax - -```cpp +Creates a definition for a generic type parameter, and gets a token to that generic type parameter. + +## Syntax + +```cpp HRESULT DefineGenericParam ( [in] mdToken tk, [in] ULONG ulParamSeq, @@ -31,43 +30,43 @@ HRESULT DefineGenericParam ( [in] LPCWSTR szname, [in] DWORD reserved, [in] mdToken rtkConstraints[], - [out] mdGenericParam *pgp -); -``` - -## Parameters - - `tk` - [in] An `mdTypeDef` or `mdMethodDef` token that represents the method or constructor for which to define a generic parameter. - - `ulParamSeq` - [in] The index of the generic parameter. - - `dwParamFlags` - [in] A value of the [CorGenericParamAttr](corgenericparamattr-enumeration.md) enumeration that describes the type for the generic parameter. - - `szname` - [in] The name of the parameter. - - `reserved` - [in] This parameter is reserved for future extensibility. - - `rtkConstraints` - [in] A zero-terminated array of type constraints. Array members must be an `mdTypeDef`, `mdTypeRef`, or `mdTypeSpec` metadata token. - - `pgp` - [out] A token that represents the generic parameter. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [out] mdGenericParam *pgp +); +``` + +## Parameters + + `tk` + [in] An `mdTypeDef` or `mdMethodDef` token that represents the method or constructor for which to define a generic parameter. + + `ulParamSeq` + [in] The index of the generic parameter. + + `dwParamFlags` + [in] A value of the [CorGenericParamAttr](corgenericparamattr-enumeration.md) enumeration that describes the type for the generic parameter. + + `szname` + [in] The name of the parameter. + + `reserved` + [in] This parameter is reserved for future extensibility. + + `rtkConstraints` + [in] A zero-terminated array of type constraints. Array members must be an `mdTypeDef`, `mdTypeRef`, or `mdTypeSpec` metadata token. + + `pgp` + [out] A token that represents the generic parameter. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md index 603016916eb09..33eb4c4a74403 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataEmit2::DefineMethodSpec Method" title: "IMetaDataEmit2::DefineMethodSpec Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit2.DefineMethodSpec" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit2::DefineMethodSpec" -helpviewer_keywords: +helpviewer_keywords: - "DefineMethodSpec method [.NET Framework metadata]" - "IMetaDataEmit2::DefineMethodSpec method [.NET Framework metadata]" -ms.assetid: 3c24e552-fc69-4971-b65a-a3e4b5f7f1e8 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit2::DefineMethodSpec Method -Creates a generic instance of a method, and gets a token to the definition. - -## Syntax - -```cpp -HRESULT DefineMethodSpec ( +Creates a generic instance of a method, and gets a token to the definition. + +## Syntax + +```cpp +HRESULT DefineMethodSpec ( [in] mdToken tkParent, [in] PCCOR_SIGNATURE pvSigBlob, [in] ULONG cbSigBlob, - [out] mdMethodSpec *pmi -); -``` - -## Parameters - - `tkParent` - [in] A token for the method of which to create the generic instance. The token must be of type `mdMethodDef` or `mdMemberRef`. - - `pvSigBlob` - [in] A pointer to the binary COM+ signature of the method. - - `cbSibBlob` - [in] The size, in bytes, of `pvSigBlob`. - - `pmi` - [out] A token to the metadata signature definition of the method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [out] mdMethodSpec *pmi +); +``` + +## Parameters + + `tkParent` + [in] A token for the method of which to create the generic instance. The token must be of type `mdMethodDef` or `mdMemberRef`. + + `pvSigBlob` + [in] A pointer to the binary COM+ signature of the method. + + `cbSibBlob` + [in] The size, in bytes, of `pvSigBlob`. + + `pmi` + [out] A token to the metadata signature definition of the method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md new file mode 100644 index 0000000000000..2e073adc174ec --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataEmit2::GetDeltaSaveSize Method" +title: "IMetaDataEmit2::GetDeltaSaveSize Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit2.GetDeltaSaveSize" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit2::GetDeltaSaveSize" +helpviewer_keywords: + - "IMetaDataEmit2::GetDeltaSaveSize method [.NET Framework metadata]" + - "GetDeltaSaveSize method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit2::GetDeltaSaveSize Method + +Gets a value indicating any change in metadata size that results from the current edit-and-continue session. + +## Syntax + +```cpp +HRESULT GetDeltaSaveSize ( + [in] CorSaveSize fSave, + [out] DWORD *pdwSaveSize +); +``` + +## Parameters + + `fSave` + [in] One of the [CorSaveSize](corsavesize-enumeration.md) values, indicating the level of precision desired. For .NET Framework version 2.0, this parameter is ignored. + + `pdwSaveSize` + [out] The change in the size of the metadata. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) +- [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md similarity index 64% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-interface.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-interface.md index f377fae062db8..23fd095640da5 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md @@ -2,47 +2,46 @@ description: "Learn more about: IMetaDataEmit2 Interface" title: "IMetaDataEmit2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit2" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit2 interface [.NET Framework metadata]" -ms.assetid: 866dc96b-bbfc-4c0f-80c2-38ce93072106 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit2 Interface -Extends the [IMetaDataEmit](imetadataemit-interface.md) interface primarily to provide the ability to work with generic types. - -## Methods - -|Method|Description| -|------------|-----------------| -|[DefineGenericParam Method](imetadataemit2-definegenericparam-method.md)|Creates a definition for a generic type parameter, and gets a token to that generic type parameter.| -|[DefineMethodSpec Method](imetadataemit2-definemethodspec-method.md)|Creates a generic instance of a method, and gets a token to the definition.| -|[GetDeltaSaveSize Method](imetadataemit2-getdeltasavesize-method.md)|Gets a value indicating the difference in size of the data that is required to express the changes for the current edit-and-continue session.| -|[ResetENCLog Method](imetadataemit2-resetenclog-method.md)|Resets the edit-and-continue log and starts a new session.| -|[SaveDelta Method](imetadataemit2-savedelta-method.md)|Saves changes from the current edit-and-continue session to the specified file.| -|[SaveDeltaToMemory Method](imetadataemit2-savedeltatomemory-method.md)|Saves changes from the current edit-and-continue session to memory.| -|[SaveDeltaToStream Method](imetadataemit2-savedeltatostream-method.md)|Saves changes from the current edit-and-continue session to the specified stream.| -|[SetGenericParamProps Method](imetadataemit2-setgenericparamprops-method.md)|Sets property values for the generic parameter definition referenced by the specified token.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Extends the [IMetaDataEmit](imetadataemit-interface.md) interface primarily to provide the ability to work with generic types. + +## Methods + +|Method|Description| +|------------|-----------------| +|[DefineGenericParam Method](imetadataemit2-definegenericparam-method.md)|Creates a definition for a generic type parameter, and gets a token to that generic type parameter.| +|[DefineMethodSpec Method](imetadataemit2-definemethodspec-method.md)|Creates a generic instance of a method, and gets a token to the definition.| +|[GetDeltaSaveSize Method](imetadataemit2-getdeltasavesize-method.md)|Gets a value indicating the difference in size of the data that is required to express the changes for the current edit-and-continue session.| +|[ResetENCLog Method](imetadataemit2-resetenclog-method.md)|Resets the edit-and-continue log and starts a new session.| +|[SaveDelta Method](imetadataemit2-savedelta-method.md)|Saves changes from the current edit-and-continue session to the specified file.| +|[SaveDeltaToMemory Method](imetadataemit2-savedeltatomemory-method.md)|Saves changes from the current edit-and-continue session to memory.| +|[SaveDeltaToStream Method](imetadataemit2-savedeltatostream-method.md)|Saves changes from the current edit-and-continue session to the specified stream.| +|[SetGenericParamProps Method](imetadataemit2-setgenericparamprops-method.md)|Sets property values for the generic parameter definition referenced by the specified token.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md new file mode 100644 index 0000000000000..225dd5e0b8c80 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md @@ -0,0 +1,46 @@ +--- +description: "Learn more about: IMetaDataEmit2::ResetENCLog Method" +title: "IMetaDataEmit2::ResetENCLog Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit2.ResetENCLog" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit2::ResetENCLog" +helpviewer_keywords: + - "ResetENCLog method [.NET Framework metadata]" + - "IMetaDataEmit2::ResetENCLog method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit2::ResetENCLog Method + +Resets the edit-and-continue log and starts a new session. + +## Syntax + +```cpp +HRESULT ResetENCLog (); +``` + +## Parameters + + `ResetENCLog` takes no parameters. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) +- [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md new file mode 100644 index 0000000000000..8c2ccde55df48 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataEmit2::SaveDelta Method" +title: "IMetaDataEmit2::SaveDelta Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataEmit2.SaveDelta" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataEmit2::SaveDelta" +helpviewer_keywords: + - "IMetaDataEmit2::SaveDelta method [.NET Framework metadata]" + - "SaveDelta method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataEmit2::SaveDelta Method + +Saves changes from the current edit-and-continue session to the specified file. + +## Syntax + +```cpp +HRESULT SaveDelta ( + [in] LPCWSTR szFile, + [in] DWORD dwSaveFlags +); +``` + +## Parameters + + `szFile` + [in] The file name under which to save changes. + + `dwSaveFlags` + [in] Reserved. Must be zero. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) +- [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md similarity index 58% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md index 5f40a7c94528d..8ce8979e98256 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit2::SaveDeltaToMemory Method" title: "IMetaDataEmit2::SaveDeltaToMemory Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit2.SaveDeltaToMemory" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit2::SaveDeltaToMemory" -helpviewer_keywords: +helpviewer_keywords: - "SaveDeltaToMemory method [.NET Framework metadata]" - "IMetaDataEmit2::SaveDeltaToMemory method [.NET Framework metadata]" -ms.assetid: e2146726-0084-4c9e-a2d2-e8d461b13b21 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit2::SaveDeltaToMemory Method -Saves changes from the current edit-and-continue session to memory. - -## Syntax - -```cpp -HRESULT SaveDeltaToMemory ( +Saves changes from the current edit-and-continue session to memory. + +## Syntax + +```cpp +HRESULT SaveDeltaToMemory ( [out] void *pbData, - [in] ULONG cbData -); -``` - -## Parameters - - `pbData` - [out] The address at which to begin writing the metadata delta. - - `cbData` - [in] The size of the changes. Use [IMetaDataEmit2::GetDeltaSaveSize](imetadataemit2-getdeltasavesize-method.md) to determine the size. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [in] ULONG cbData +); +``` + +## Parameters + + `pbData` + [out] The address at which to begin writing the metadata delta. + + `cbData` + [in] The size of the changes. Use [IMetaDataEmit2::GetDeltaSaveSize](imetadataemit2-getdeltasavesize-method.md) to determine the size. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md index 66abc1d4a8b71..a71476184d697 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit2::SaveDeltaToStream Method" title: "IMetaDataEmit2::SaveDeltaToStream Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit2.SaveDeltaToStream" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit2::SaveDeltaToStream" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit2::SaveDeltaToStream method [.NET Framework metadata]" - "SaveDeltaToStream method [.NET Framework metadata]" -ms.assetid: ecd786e8-f9a4-4190-a6ef-af18e8c6d654 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit2::SaveDeltaToStream Method -Saves changes from the current edit-and-continue session to the specified stream. - -## Syntax - -```cpp -HRESULT SaveDeltaToStream ( +Saves changes from the current edit-and-continue session to the specified stream. + +## Syntax + +```cpp +HRESULT SaveDeltaToStream ( [in] IStream *pIStream, - [in] DWORD dwSaveFlags -); -``` - -## Parameters - - `pIStream` - [in] An interface pointer to the writable stream to which to save changes. - - `dwSaveFlags` - [in] Reserved. This value must be zero. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [in] DWORD dwSaveFlags +); +``` + +## Parameters + + `pIStream` + [in] An interface pointer to the writable stream to which to save changes. + + `dwSaveFlags` + [in] Reserved. This value must be zero. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md similarity index 60% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md index cdfa59eabd2cc..4e03a00f38494 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataEmit2::SetGenericParamProps Method" title: "IMetaDataEmit2::SetGenericParamProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit2.SetGenericParamProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit2::SetGenericParamProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit2::SetGenericParamProps method [.NET Framework metadata]" - "SetGenericParamProps method [.NET Framework metadata]" -ms.assetid: cd93a48d-1fed-4706-bec6-a05dc3b64fbd -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit2::SetGenericParamProps Method -Sets property values for the generic parameter definition referenced by the specified token. - -## Syntax - -```cpp -HRESULT SetGenericParamProps ( +Sets property values for the generic parameter definition referenced by the specified token. + +## Syntax + +```cpp +HRESULT SetGenericParamProps ( [in] mdGenericParam gp, [in] DWORD dwParamFlags, [in] LPCWSTR szName, [in] DWORD reserved, - [in] mdToken rtkConstraints[] -); -``` - -## Parameters - - `gp` - [in] The token for the generic parameter definition for which to set values. - - `dwParamFlags` - [in] A value of the [CorGenericParamAttr](corgenericparamattr-enumeration.md) enumeration that describes the type for the generic parameter. - - `szName` - [in] Optional. The name of the parameter for which to set values. - - `reserved` - [in] Reserved for future extensibility. - - `rtkConstraints` - [in] Optional. A zero-terminated array of type constraints. Array members must be an `mdTypeDef`, `mdTypeRef`, or `mdTypeSpec` metadata token. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] mdToken rtkConstraints[] +); +``` + +## Parameters + + `gp` + [in] The token for the generic parameter definition for which to set values. + + `dwParamFlags` + [in] A value of the [CorGenericParamAttr](corgenericparamattr-enumeration.md) enumeration that describes the type for the generic parameter. + + `szName` + [in] Optional. The name of the parameter for which to set values. + + `reserved` + [in] Reserved for future extensibility. + + `rtkConstraints` + [in] Optional. A zero-terminated array of type constraints. Array members must be an `mdTypeDef`, `mdTypeRef`, or `mdTypeSpec` metadata token. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataerror-interface.md b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md new file mode 100644 index 0000000000000..427bc8ec46f15 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md @@ -0,0 +1,43 @@ +--- +description: "Learn more about: IMetaDataError Interface" +title: "IMetaDataError Interface" +ms.date: "03/30/2017" +api_name: + - "IMetaDataError" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataError" +helpviewer_keywords: + - "IMetaDataError interface [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataError Interface + +Provides a callback mechanism for reporting errors during the metadata merge. + +> [!NOTE] +> The `IMetaDataError` interface must be implemented by the client. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnError Method](imetadataerror-onerror-method.md)|Provides notification of errors that occur during the metadata merge.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md new file mode 100644 index 0000000000000..c77483c3a90c8 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md @@ -0,0 +1,52 @@ +--- +description: "Learn more about: IMetaDataError::OnError Method" +title: "IMetaDataError::OnError Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataError.OnError" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataError::OnError" +helpviewer_keywords: + - "IMetaDataError::OnError method [.NET Framework metadata]" + - "OnError method, IMetaDataError interface [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataError::OnError Method + +Provides notification of errors that occur during the metadata merge. + +## Syntax + +```cpp +HRESULT OnError ( + [in] HRESULT hrError, + [in] mdToken token +); +``` + +## Parameters + + `hrError` + [in] The HRESULT error value returned to the calling method. + + `token` + [in] The metadata token of the code object that was being merged when the error occurred. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataError Interface](imetadataerror-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatafilter-interface.md b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md similarity index 56% rename from docs/framework/unmanaged-api/metadata/imetadatafilter-interface.md rename to docs/core/unmanaged-api/metadata/imetadatafilter-interface.md index 5d32449000750..a95b80c8cbec0 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatafilter-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md @@ -2,42 +2,41 @@ description: "Learn more about: IMetaDataFilter Interface" title: "IMetaDataFilter Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataFilter" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataFilter" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataFilter interface [.NET Framework metadata]" -ms.assetid: ec0856ef-8c56-40ba-bf60-86e0ce8b337f -topic_type: +topic_type: - "apiref" --- # IMetaDataFilter Interface -Provides methods for marking and filtering metadata tokens to avoid repeating actions that have already been taken. - -## Methods - -|Method|Description| -|------------|-----------------| -|[IsTokenMarked Method](imetadatafilter-istokenmarked-method.md)|Gets a value indicating whether the specified metadata token has been processed.| -|[MarkToken Method](imetadatafilter-marktoken-method.md)|Sets a value indicating that the specified metadata token has been processed.| -|[UnmarkAll Method](imetadatafilter-unmarkall-method.md)|Removes the processing marks from all the tokens in the current metadata scope.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides methods for marking and filtering metadata tokens to avoid repeating actions that have already been taken. + +## Methods + +|Method|Description| +|------------|-----------------| +|[IsTokenMarked Method](imetadatafilter-istokenmarked-method.md)|Gets a value indicating whether the specified metadata token has been processed.| +|[MarkToken Method](imetadatafilter-marktoken-method.md)|Sets a value indicating that the specified metadata token has been processed.| +|[UnmarkAll Method](imetadatafilter-unmarkall-method.md)|Removes the processing marks from all the tokens in the current metadata scope.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md new file mode 100644 index 0000000000000..2b06280662cb9 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md @@ -0,0 +1,52 @@ +--- +description: "Learn more about: IMetaDataFilter::IsTokenMarked Method" +title: "IMetaDataFilter::IsTokenMarked Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataFilter.IsTokenMarked" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataFilter::IsTokenMarked" +helpviewer_keywords: + - "IMetaDataFilter::IsTokenMarked method [.NET Framework metadata]" + - "IsTokenMarked method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataFilter::IsTokenMarked Method + +Gets a value indicating whether the specified metadata token has been marked as processed. + +## Syntax + +```cpp +HRESULT IsTokenMarked ( + [in] mdToken tk, + [out] BOOL *pIsMarked +); +``` + +## Parameters + + `tk` + [in] The token to examine for a processing mark. + + `pIsMarked` + [out] A value that is `true` if `tk` has been processed; otherwise `false`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataFilter Interface](imetadatafilter-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md new file mode 100644 index 0000000000000..aeb1870c8ba7c --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md @@ -0,0 +1,48 @@ +--- +description: "Learn more about: IMetaDataFilter::MarkToken Method" +title: "IMetaDataFilter::MarkToken Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataFilter.MarkToken" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataFilter::MarkToken" +helpviewer_keywords: + - "IMetaDataFilter::MarkToken method [.NET Framework metadata]" + - "MarkToken method, IMetaDataFilter interface [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataFilter::MarkToken Method + +Sets a value indicating that the specified metadata token has been processed. + +## Syntax + +```cpp +HRESULT MarkToken ( + [in] mdToken tk +); +``` + +## Parameters + + `tk` + [in] The token to mark as processed. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataFilter Interface](imetadatafilter-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md new file mode 100644 index 0000000000000..f34e6803ec181 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md @@ -0,0 +1,45 @@ +--- +description: "Learn more about: IMetaDataFilter::UnmarkAll Method" +title: "IMetaDataFilter::UnmarkAll Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataFilter.UnmarkAll" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataFilter::UnmarkAll" +helpviewer_keywords: + - "IMetaDataFilter::UnmarkAll method [.NET Framework metadata]" + - "UnmarkAll method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataFilter::UnmarkAll Method + +Removes the processing marks from all the tokens in the current metadata scope. + +## Syntax + +```cpp +HRESULT UnmarkAll (); +``` + +## Parameters + + `UnmarkAll` takes no parameters. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataFilter Interface](imetadatafilter-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataimport-closeenum-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md index fbc1b1ea8c7fb..926579f05b706 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-closeenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataImport::CloseEnum Method" title: "IMetaDataImport::CloseEnum Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.CloseEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::CloseEnum" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::CloseEnum method [.NET Framework metadata]" - "CloseEnum method, IMetaDataImport interface [.NET Framework metadata]" -ms.assetid: 727819d5-1dab-4ebb-ac25-950b4111dc72 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::CloseEnum Method -Closes the enumerator that is identified by the specified handle. - -## Syntax - -```cpp -void CloseEnum ( - [in] HCORENUM hEnum -); -``` - -## Parameters - - `hEnum` - [in] The handle for the enumerator to close. - -## Remarks - - The handle specified by `hEnum` is obtained from a previous `Enum`*Name* call (for example, [IMetaDataImport::EnumTypeDefs](imetadataimport-enumtypedefs-method.md)). - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Closes the enumerator that is identified by the specified handle. + +## Syntax + +```cpp +void CloseEnum ( + [in] HCORENUM hEnum +); +``` + +## Parameters + + `hEnum` + [in] The handle for the enumerator to close. + +## Remarks + + The handle specified by `hEnum` is obtained from a previous `Enum`*Name* call (for example, [IMetaDataImport::EnumTypeDefs](imetadataimport-enumtypedefs-method.md)). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-countenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataimport-countenum-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md index dce9f7a021791..ba78c4b9c3d4e 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-countenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport::CountEnum Method" title: "IMetaDataImport::CountEnum Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.CountEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::CountEnum" -helpviewer_keywords: +helpviewer_keywords: - "CountEnum method [.NET Framework metadata]" - "IMetaDataImport::CountEnum method [.NET Framework metadata]" -ms.assetid: d1de53ad-9435-4b5f-9df7-07f21210e5b5 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::CountEnum Method -Gets the number of elements in the enumeration that was retrieved by the specified enumerator. - -## Syntax - -```cpp -HRESULT CountEnum ( +Gets the number of elements in the enumeration that was retrieved by the specified enumerator. + +## Syntax + +```cpp +HRESULT CountEnum ( [in] HCORENUM hEnum, - [out] ULONG *pulCount -); -``` - -## Parameters - - `hEnum` - [in] The handle for the enumerator. - - `pulCount` - [out] The number of elements enumerated. - -## Remarks - - The handle specified by `hEnum` is obtained from a previous `Enum`*Name* call (for example, [IMetaDataImport::EnumTypeDefs](imetadataimport-enumtypedefs-method.md)). - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] ULONG *pulCount +); +``` + +## Parameters + + `hEnum` + [in] The handle for the enumerator. + + `pulCount` + [out] The number of elements enumerated. + +## Remarks + + The handle specified by `hEnum` is obtained from a previous `Enum`*Name* call (for example, [IMetaDataImport::EnumTypeDefs](imetadataimport-enumtypedefs-method.md)). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md new file mode 100644 index 0000000000000..cb930f88787f9 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md @@ -0,0 +1,76 @@ +--- +description: "Learn more about: IMetaDataImport::EnumCustomAttributes Method" +title: "IMetaDataImport::EnumCustomAttributes Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumCustomAttributes" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumCustomAttributes" +helpviewer_keywords: + - "EnumCustomAttributes method [.NET Framework metadata]" + - "IMetaDataImport::EnumCustomAttributes method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumCustomAttributes Method + +Enumerates custom attribute-definition tokens associated with the specified type or member. + +## Syntax + +```cpp +HRESULT EnumCustomAttributes ( + [in, out] HCORENUM *phEnum, + [in] mdToken tk, + [in] mdToken tkType, + [out] mdCustomAttribute rCustomAttributes[], + [in] ULONG cMax, + [out, optional] ULONG *pcCustomAttributes +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the returned enumerator. + + `tk` + [in] A token for the scope of the enumeration, or zero for all custom attributes. + + `tkType` + [in] A token for the constructor of the type of the attributes to be enumerated, or `null` for all types. + + `rCustomAttributes` + [out] An array of custom attribute tokens. + + `cMax` + [in] The maximum size of the `rCustomAttributes` array. + + `pcCustomAttributes` + [out, optional] The actual number of token values returned in `rCustomAttributes`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumCustomAttributes` returned successfully.| +|`S_FALSE`|There are no custom attributes to enumerate. In that case, `pcCustomAttributes` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md new file mode 100644 index 0000000000000..ea5a196603c5c --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumEvents Method" +title: "IMetaDataImport::EnumEvents Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumEvents" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumEvents" +helpviewer_keywords: + - "IMetaDataImport::EnumEvents method [.NET Framework metadata]" + - "EnumEvents method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumEvents Method + +Enumerates event definition tokens for the specified TypeDef token. + +## Syntax + +```cpp +HRESULT EnumEvents ( + [in, out] HCORENUM *phEnum, + [in] mdTypeDef td, + [out] mdEvent rEvents[], + [in] ULONG cMax, + [out] ULONG *pcEvents +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. + + `td` + [in] The TypeDef token whose event definitions are to be enumerated. + + `rEvents` + [out] The array of returned events. + + `cMax` + [in] The maximum size of the `rEvents` array. + + `pcEvents` + [out] The actual number of events returned in `rEvents`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumEvents` returned successfully.| +|`S_FALSE`|There are no events to enumerate. In that case, `pcEvents` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumfields-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumfields-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md index c217a2a83f35b..989f7ab44897c 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumfields-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumFields Method" title: "IMetaDataImport::EnumFields Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumFields" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumFields" -helpviewer_keywords: +helpviewer_keywords: - "EnumFields method [.NET Framework metadata]" - "IMetaDataImport::EnumFields method [.NET Framework metadata]" -ms.assetid: 1d23247e-c58c-45db-afd8-83aa89cde18e -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumFields Method -Enumerates FieldDef tokens for the type referenced by the specified TypeDef token. - -## Syntax - -```cpp +Enumerates FieldDef tokens for the type referenced by the specified TypeDef token. + +## Syntax + +```cpp HRESULT EnumFields ( [in, out] HCORENUM *phEnum, [in] mdTypeDef cl, [out] mdFieldDef rFields[], [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. - - `cl` - [in] The TypeDef token of the class whose fields are to be enumerated. - - `rFields` - [out] The list of FieldDef tokens. - - `cMax` - [in] The maximum size of the `rFields` array. - - `pcTokens` - [out] The actual number of FieldDef tokens returned in `rFields`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumFields` returned successfully.| -|`S_FALSE`|There are no fields to enumerate. In that case, `pcTokens` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. + + `cl` + [in] The TypeDef token of the class whose fields are to be enumerated. + + `rFields` + [out] The list of FieldDef tokens. + + `cMax` + [in] The maximum size of the `rFields` array. + + `pcTokens` + [out] The actual number of FieldDef tokens returned in `rFields`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumFields` returned successfully.| +|`S_FALSE`|There are no fields to enumerate. In that case, `pcTokens` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md index f7f8162b58f29..eff260e67ab3b 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md @@ -2,79 +2,78 @@ description: "Learn more about: IMetaDataImport::EnumFieldsWithName Method" title: "IMetaDataImport::EnumFieldsWithName Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumFieldsWithName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumFieldsWithName" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumFieldsWithName method [.NET Framework metadata]" - "EnumFieldsWithName method [.NET Framework metadata]" -ms.assetid: 42145e8d-000f-4d0b-ae43-c08201190fa2 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumFieldsWithName Method -Enumerates FieldDef tokens of the specified type with the specified name. - -## Syntax - -```cpp -HRESULT EnumFieldsWithName ( +Enumerates FieldDef tokens of the specified type with the specified name. + +## Syntax + +```cpp +HRESULT EnumFieldsWithName ( [in, out] HCORENUM *phEnum, [in] mdTypeDef cl, [in] LPCWSTR szName, [out] mdFieldDef rFields[], [in] ULONG cMax, [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. - - `cl` - [in] The token of the type whose fields are to be enumerated. - - `szName` - [in] The field name that limits the scope of the enumeration. - - `rFields` - [out] Array used to store the FieldDef tokens. - - `cMax` - [in] The maximum size of the `rFields` array. - - `pcTokens` - [out] The actual number of FieldDef tokens returned in `rFields`. - -## Remarks - - Unlike [IMetaDataImport::EnumFields](imetadataimport-enumfields-method.md), `EnumFieldsWithName` discards all field tokens that do not have the specified name. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumFieldsWithName` returned successfully.| -|`S_FALSE`|There are no fields to enumerate. In that case, `pcTokens` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. + + `cl` + [in] The token of the type whose fields are to be enumerated. + + `szName` + [in] The field name that limits the scope of the enumeration. + + `rFields` + [out] Array used to store the FieldDef tokens. + + `cMax` + [in] The maximum size of the `rFields` array. + + `pcTokens` + [out] The actual number of FieldDef tokens returned in `rFields`. + +## Remarks + + Unlike [IMetaDataImport::EnumFields](imetadataimport-enumfields-method.md), `EnumFieldsWithName` discards all field tokens that do not have the specified name. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumFieldsWithName` returned successfully.| +|`S_FALSE`|There are no fields to enumerate. In that case, `pcTokens` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md index 13462c2d232f9..5e201e5f0e9d3 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md @@ -2,75 +2,74 @@ description: "Learn more about: IMetaDataImport::EnumInterfaceImpls Method" title: "IMetaDataImport::EnumInterfaceImpls Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumInterfaceImpls" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumInterfaceImpls" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumInterfaceImpls method [.NET Framework metadata]" - "EnumInterfaceImpls method [.NET Framework metadata]" -ms.assetid: ba6e178f-128b-4e47-a13c-b4be73eb106c -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumInterfaceImpls Method Enumerates all interfaces implemented by the specified `TypeDef`. - -## Syntax - -```cpp -HRESULT EnumInterfaceImpls ( + +## Syntax + +```cpp +HRESULT EnumInterfaceImpls ( [in, out] HCORENUM *phEnum, - [in] mdTypeDef td, + [in] mdTypeDef td, [out] mdInterfaceImpl rImpls[], - [in] ULONG cMax, - [out] ULONG* pcImpls -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. - - `td` - [in] The token of the TypeDef whose MethodDef tokens representing interface implementations are to be enumerated. - - `rImpls` - [out] The array used to store the MethodDef tokens. - - `cMax` - [in] The maximum length of the `rImpls` array. - - `pcImpls` - [out] The actual number of tokens returned in `rImpls`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumInterfaceImpls` returned successfully.| -|`S_FALSE`|There are no MethodDef tokens to enumerate. In that case, `pcImpls` is set to zero.| + [in] ULONG cMax, + [out] ULONG* pcImpls +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. + + `td` + [in] The token of the TypeDef whose MethodDef tokens representing interface implementations are to be enumerated. + + `rImpls` + [out] The array used to store the MethodDef tokens. + + `cMax` + [in] The maximum length of the `rImpls` array. + + `pcImpls` + [out] The actual number of tokens returned in `rImpls`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumInterfaceImpls` returned successfully.| +|`S_FALSE`|There are no MethodDef tokens to enumerate. In that case, `pcImpls` is set to zero.| ## Remarks The enumeration returns a collection of `mdInterfaceImpl` tokens for each interface implemented by the specified `TypeDef`. Interface tokens are returned in the order the interfaces were specified (through `DefineTypeDef` or `SetTypeDefProps`). Properties of the returned `mdInterfaceImpl` tokens can be queried using [GetInterfaceImplProps](imetadataimport-getinterfaceimplprops-method.md). - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md new file mode 100644 index 0000000000000..e21bf2c2d3210 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumMemberRefs Method" +title: "IMetaDataImport::EnumMemberRefs Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumMemberRefs" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumMemberRefs" +helpviewer_keywords: + - "EnumMemberRefs method [.NET Framework metadata]" + - "IMetaDataImport::EnumMemberRefs method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumMemberRefs Method + +Enumerates MemberRef tokens representing members of the specified type. + +## Syntax + +```cpp +HRESULT EnumMemberRefs ( + [in, out] HCORENUM *phEnum, + [in] mdToken tkParent, + [out] mdMemberRef rMemberRefs[], + [in] ULONG cMax, + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. + + `tkParent` + [in] A TypeDef, TypeRef, MethodDef, or ModuleRef token for the type whose members are to be enumerated. + + `rMemberRefs` + [out] The array used to store MemberRef tokens. + + `cMax` + [in] The maximum size of the `rMemberRefs` array. + + `pcTokens` + [out] The actual number of MemberRef tokens returned in `rMemberRefs`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumMemberRefs` returned successfully.| +|`S_FALSE`|There are no MemberRef tokens to enumerate. In that case, `pcTokens` is to zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummembers-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md similarity index 63% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummembers-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md index 5f83a98922163..60f9e33a026b2 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enummembers-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md @@ -2,77 +2,76 @@ description: "Learn more about: IMetaDataImport::EnumMembers Method" title: "IMetaDataImport::EnumMembers Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumMembers" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumMembers" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumMembers method [.NET Framework metadata]" - "EnumMembers method [.NET Framework metadata]" -ms.assetid: 3fb8e178-342b-4c89-9bcf-f7f834e6cb77 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumMembers Method -Enumerates MemberDef tokens representing members of the specified type. - -## Syntax - -```cpp +Enumerates MemberDef tokens representing members of the specified type. + +## Syntax + +```cpp HRESULT EnumMembers ( [in, out] HCORENUM *phEnum, [in] mdTypeDef cl, [out] mdToken rMembers[], [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. - - `cl` - [in] A TypeDef token representing the type whose members are to be enumerated. - - `rMembers` - [out] The array used to hold the MemberDef tokens. - - `cMax` - [in] The maximum size of the `rMembers` array. - - `pcTokens` - [out] The actual number of MemberDef tokens returned in `rMembers`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumMembers` returned successfully.| -|`S_FALSE`|There are no MemberDef tokens to enumerate. In that case, `pcTokens` is zero.| - -## Remarks + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. + + `cl` + [in] A TypeDef token representing the type whose members are to be enumerated. + + `rMembers` + [out] The array used to hold the MemberDef tokens. + + `cMax` + [in] The maximum size of the `rMembers` array. + + `pcTokens` + [out] The actual number of MemberDef tokens returned in `rMembers`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumMembers` returned successfully.| +|`S_FALSE`|There are no MemberDef tokens to enumerate. In that case, `pcTokens` is zero.| + +## Remarks When enumerating collections of members for a class, `EnumMembers` returns only members (fields and methods, but **not** properties or events) defined directly on the class. It does not return any members that the class inherits, even if the class provides an implementation for those inherited members. To enumerate inherited members, the caller must explicitly walk the inheritance chain. Note that the rules for the inheritance chain may vary depending on the language or compiler that emitted the original metadata. Properties and events are not enumerated by `EnumMembers`. To enumerate those, use [EnumProperties](imetadataimport-enumproperties-method.md) or [EnumEvents](imetadataimport-enumevents-method.md). - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md index 571680083c57e..17ce30b714c7d 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md @@ -2,79 +2,78 @@ description: "Learn more about: IMetaDataImport::EnumMembersWithName Method" title: "IMetaDataImport::EnumMembersWithName Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumMembersWithName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumMembersWithName" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumMembersWithName method [.NET Framework metadata]" - "EnumMembersWithName method [.NET Framework metadata]" -ms.assetid: 7c9e9120-3104-42f0-86ce-19a025f20dcc -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumMembersWithName Method -Enumerates MemberDef tokens representing members of the specified type with the specified name. - -## Syntax - -```cpp -HRESULT EnumMembersWithName ( +Enumerates MemberDef tokens representing members of the specified type with the specified name. + +## Syntax + +```cpp +HRESULT EnumMembersWithName ( [in, out] HCORENUM *phEnum, [in] mdTypeDef cl, [in] LPCWSTR szName, [out] mdToken rMembers[], [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. - - `cl` - [in] A TypeDef token representing the type with members to enumerate. - - `szName` - [in] The member name that limits the scope of the enumerator. - - `rMembers` - [out] The array used to store the MemberDef tokens. - - `cMax` - [in] The maximum size of the `rMembers` array. - - `pcTokens` - [out] The actual number of MemberDef tokens returned in `rMembers`. - -## Remarks - - This method enumerates fields and methods, but not properties or events. Unlike [IMetaDataImport::EnumMembers](imetadataimport-enummembers-method.md), `EnumMembersWithName` discards all field and member tokens that do not have the specified name. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumTypeDefs` returned successfully.| -|`S_FALSE`|There are no MemberDef tokens to enumerate. In that case, `pcTokens` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. + + `cl` + [in] A TypeDef token representing the type with members to enumerate. + + `szName` + [in] The member name that limits the scope of the enumerator. + + `rMembers` + [out] The array used to store the MemberDef tokens. + + `cMax` + [in] The maximum size of the `rMembers` array. + + `pcTokens` + [out] The actual number of MemberDef tokens returned in `rMembers`. + +## Remarks + + This method enumerates fields and methods, but not properties or events. Unlike [IMetaDataImport::EnumMembers](imetadataimport-enummembers-method.md), `EnumMembersWithName` discards all field and member tokens that do not have the specified name. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumTypeDefs` returned successfully.| +|`S_FALSE`|There are no MemberDef tokens to enumerate. In that case, `pcTokens` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md index 7713f0b0b4a1e..2321262529e8d 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md @@ -2,75 +2,74 @@ description: "Learn more about: IMetaDataImport::EnumMethodImpls Method" title: "IMetaDataImport::EnumMethodImpls Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumMethodImpls" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumMethodImpls" -helpviewer_keywords: +helpviewer_keywords: - "EnumMethodImpls method [.NET Framework metadata]" - "IMetaDataImport::EnumMethodImpls method [.NET Framework metadata]" -ms.assetid: 4e0f865d-88b5-44bd-be35-492622e5e08e -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumMethodImpls Method -Enumerates MethodBody and MethodDeclaration tokens representing methods of the specified type. - -## Syntax - -```cpp -HRESULT EnumMethodImpls ( +Enumerates MethodBody and MethodDeclaration tokens representing methods of the specified type. + +## Syntax + +```cpp +HRESULT EnumMethodImpls ( [in, out] HCORENUM *phEnum, [in] mdTypeDef td, [out] mdToken rMethodBody[], [out] mdToken rMethodDecl[], [in] ULONG cMax, - [in] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `td` - [in] A TypeDef token for the type whose method implementations to enumerate. - - `rMethodBody` - [out] The array to store the MethodBody tokens. - - `rMethodDecl` - [out] The array to store the MethodDeclaration tokens. - - `cMax` - [in] The maximum size of the `rMethodBody` and `rMethodDecl` arrays. - - `pcTokens` - [in] The actual number of methods returned in `rMethodBody` and `rMethodDecl`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumMethodImpls` returned successfully.| -|`S_FALSE`|There are no method tokens to enumerate. In that case, `pcTokens` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `td` + [in] A TypeDef token for the type whose method implementations to enumerate. + + `rMethodBody` + [out] The array to store the MethodBody tokens. + + `rMethodDecl` + [out] The array to store the MethodDeclaration tokens. + + `cMax` + [in] The maximum size of the `rMethodBody` and `rMethodDecl` arrays. + + `pcTokens` + [in] The actual number of methods returned in `rMethodBody` and `rMethodDecl`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumMethodImpls` returned successfully.| +|`S_FALSE`|There are no method tokens to enumerate. In that case, `pcTokens` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md new file mode 100644 index 0000000000000..de237a01b922d --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumMethods Method" +title: "IMetaDataImport::EnumMethods Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumMethods" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumMethods" +helpviewer_keywords: + - "IMetaDataImport::EnumMethods method [.NET Framework metadata]" + - "EnumMethods method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumMethods Method + +Enumerates MethodDef tokens representing methods of the specified type. + +## Syntax + +```cpp +HRESULT EnumMethods ( + [in, out] HCORENUM *phEnum, + [in] mdTypeDef cl, + [out] mdMethodDef rMethods[], + [in] ULONG cMax, + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `cl` + [in] A TypeDef token representing the type with the methods to enumerate. + + `rMethods` + [out] The array to store the MethodDef tokens. + + `cMax` + [in] The maximum size of the MethodDef `rMethods` array. + + `pcTokens` + [out] The number of MethodDef tokens returned in `rMethods`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumMethods` returned successfully.| +|`S_FALSE`|There are no MethodDef tokens to enumerate. In that case, `pcTokens` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md similarity index 61% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md index 05f81a4ab4cea..1c85bb3877239 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md @@ -2,75 +2,74 @@ description: "Learn more about: IMetaDataImport::EnumMethodSemantics Method" title: "IMetaDataImport::EnumMethodSemantics Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumMethodSemantics" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumMethodSemantics" -helpviewer_keywords: +helpviewer_keywords: - "EnumMethodSemantics method [.NET Framework metadata]" - "IMetaDataImport::EnumMethodSemantics method [.NET Framework metadata]" -ms.assetid: e7e3c630-9691-46d6-94df-b5593a7bb08a -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumMethodSemantics Method -Enumerates the properties and the property-change events to which the specified method is related. - -## Syntax - -```cpp -HRESULT EnumMethodSemantics ( - [in, out] HCORENUM *phEnum, +Enumerates the properties and the property-change events to which the specified method is related. + +## Syntax + +```cpp +HRESULT EnumMethodSemantics ( + [in, out] HCORENUM *phEnum, [in] mdMethodDef mb, - [out] mdToken rEventProp[], - [in] ULONG cMax, - [out] ULONG *pcEventProp -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `mb` - [in] A MethodDef token that limits the scope of the enumeration. - - `rEventProp` - [out] The array used to store the events or properties. - - `cMax` - [in] The maximum size of the `rEventProp` array. - - `pcEventProp` - [out] The number of events or properties returned in `rEventProp`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumMethodSemantics` returned successfully.| -|`S_FALSE`|There are no events or properties to enumerate. In that case, `pcEventProp` is zero.| - -## Remarks - - Many common language runtime types define *Property*`Changed` events and `On`*Property*`Changed` methods related to their properties. For example, the type defines a property, a event, and an method. The set accessor method of the property calls method, which in turn raises the event. You would call `EnumMethodSemantics` using the MethodDef for to get references to the property and the event. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] mdToken rEventProp[], + [in] ULONG cMax, + [out] ULONG *pcEventProp +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `mb` + [in] A MethodDef token that limits the scope of the enumeration. + + `rEventProp` + [out] The array used to store the events or properties. + + `cMax` + [in] The maximum size of the `rEventProp` array. + + `pcEventProp` + [out] The number of events or properties returned in `rEventProp`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumMethodSemantics` returned successfully.| +|`S_FALSE`|There are no events or properties to enumerate. In that case, `pcEventProp` is zero.| + +## Remarks + + Many common language runtime types define *Property*`Changed` events and `On`*Property*`Changed` methods related to their properties. For example, the type defines a property, a event, and an method. The set accessor method of the property calls method, which in turn raises the event. You would call `EnumMethodSemantics` using the MethodDef for to get references to the property and the event. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md new file mode 100644 index 0000000000000..ddff59ecd9f0a --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md @@ -0,0 +1,80 @@ +--- +description: "Learn more about: IMetaDataImport::EnumMethodsWithName Method" +title: "IMetaDataImport::EnumMethodsWithName Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumMethodsWithName" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumMethodsWithName" +helpviewer_keywords: + - "IMetaDataImport::EnumMethodsWithName method [.NET Framework metadata]" + - "EnumMethodsWithName method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumMethodsWithName Method + +Enumerates methods that have the specified name and that are defined by the type referenced by the specified TypeDef token. + +## Syntax + +```cpp +HRESULT EnumMethodsWithName ( + [in, out] HCORENUM *phEnum, + [in] mdTypeDef cl, + [in] LPCWSTR szName, + [out] mdMethodDef rMethods[], + [in] ULONG cMax, + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `cl` + [in] A TypeDef token representing the type whose methods to enumerate. + + `szName` + [in] The name that limits the scope of the enumeration. + + `rMethods` + [out] The array used to store the MethodDef tokens. + + `cMax` + [in] The maximum size of the `rMethods` array. + + `pcTokens` + [out] The number of MethodDef tokens returned in `rMethods`. + +## Remarks + + This method enumerates fields and methods, but not properties or events. Unlike [IMetaDataImport::EnumMethods](imetadataimport-enummethods-method.md), `EnumMethodsWithName` discards all method tokens that do not have the specified name. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumMethodsWithName` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTokens` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md new file mode 100644 index 0000000000000..515a1ecb908fc --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md @@ -0,0 +1,68 @@ +--- +description: "Learn more about: IMetaDataImport::EnumModuleRefs Method" +title: "IMetaDataImport::EnumModuleRefs Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumModuleRefs" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumModuleRefs" +helpviewer_keywords: + - "EnumModuleRefs method [.NET Framework metadata]" + - "IMetaDataImport::EnumModuleRefs method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumModuleRefs Method + +Enumerates ModuleRef tokens that represent imported modules. + +## Syntax + +```cpp +HRESULT EnumModuleRefs ( + [in, out] HCORENUM *phEnum, + [out] mdModuleRef rModuleRefs[], + [in] ULONG cMax, + [out] ULONG *pcModuleRefs +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `rModuleRefs` + [out] The array used to store the ModuleRef tokens. + + `cMax` + [in] The maximum size of the `rModuleRefs` array. + + `pcModuleRefs` + [out] The number of ModuleRef tokens returned in `rModuleRefs`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumModuleRefs` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcModuleRefs` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md new file mode 100644 index 0000000000000..d40c1a116c1bd --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumParams Method" +title: "IMetaDataImport::EnumParams Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumParams" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumParams" +helpviewer_keywords: + - "IMetaDataImport::EnumParams method [.NET Framework metadata]" + - "EnumParams method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumParams Method + +Enumerates ParamDef tokens representing the parameters of the method referenced by the specified MethodDef token. + +## Syntax + +```cpp +HRESULT EnumParams ( + [in, out] HCORENUM *phEnum, + [in] mdMethodDef mb, + [out] mdParamDef rParams[], + [in] ULONG cMax, + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `mb` + [in] A MethodDef token representing the method with the parameters to enumerate. + + `rParams` + [out] The array used to store the ParamDef tokens. + + `cMax` + [in] The maximum size of the `rParams` array. + + `pcTokens` + [out] The number of ParamDef tokens returned in `rParams`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumParams` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTokens` is zero.| + +## Requirements + + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md new file mode 100644 index 0000000000000..80c4622ba50e1 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md @@ -0,0 +1,76 @@ +--- +description: "Learn more about: IMetaDataImport::EnumPermissionSets Method" +title: "IMetaDataImport::EnumPermissionSets Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumPermissionSets" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumPermissionSets" +helpviewer_keywords: + - "EnumPermissionSets method [.NET Framework metadata]" + - "IMetaDataImport::EnumPermissionSets method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumPermissionSets Method + +Enumerates permissions for the objects in a specified metadata scope. + +## Syntax + +```cpp +HRESULT EnumPermissionSets + [in, out] HCORENUM *phEnum, + [in] mdToken tk, + [in] DWORD dwActions, + [out] mdPermission rPermission[], + [in] ULONG cMax, + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `tk` + [in] A metadata token that limits the scope of the search, or NULL to search the widest scope possible. + + `dwActions` + [in] Flags representing the values to include in `rPermission`, or zero to return all actions. + + `rPermission` + [out] The array used to store the Permission tokens. + + `cMax` + [in] The maximum size of the `rPermission` array. + + `pcTokens` + [out] The number of Permission tokens returned in `rPermission`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumPermissionSets` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTokens` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md new file mode 100644 index 0000000000000..78e8289b55971 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumProperties Method" +title: "IMetaDataImport::EnumProperties Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumProperties" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumProperties" +helpviewer_keywords: + - "IMetaDataImport::EnumProperties method [.NET Framework metadata]" + - "EnumProperties method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumProperties Method + +Enumerates PropertyDef tokens representing the properties of the type referenced by the specified TypeDef token. + +## Syntax + +```cpp +HRESULT EnumProperties ( + [in, out] HCORENUM *phEnum, + [in] mdTypeDef td, + [out] mdProperty rProperties[], + [in] ULONG cMax, + [out] ULONG *pcProperties +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `td` + [in] A TypeDef token representing the type with properties to enumerate. + + `rProperties` + [out] The array used to store the PropertyDef tokens. + + `cMax` + [in] The maximum size of the `rProperties` array. + + `pcProperties` + [out] The number of PropertyDef tokens returned in `rProperties`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumProperties` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcProperties` is zero.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md new file mode 100644 index 0000000000000..60148ecdedeb7 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumSignatures Method" +title: "IMetaDataImport::EnumSignatures Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumSignatures" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumSignatures" +helpviewer_keywords: + - "EnumSignatures method [.NET Framework metadata]" + - "IMetaDataImport::EnumSignatures method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumSignatures Method + +Enumerates Signature tokens representing stand-alone signatures in the current scope. + +## Syntax + +```cpp +HRESULT EnumSignatures ( + [in, out] HCORENUM *phEnum, + [out] mdSignature rSignatures[], + [in] ULONG cMax, + [out] ULONG *pcSignatures +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `rSignatures` + [out] The array used to store the Signature tokens. + + `cMax` + [in] The maximum size of the `rSignatures` array. + + `pcSignatures` + [out] The number of Signature tokens returned in `rSignatures`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumSignatures` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcSignatures` is zero.| + +## Remarks + + The Signature tokens are created by the [IMetaDataEmit::GetTokenFromSig](imetadataemit-gettokenfromsig-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md new file mode 100644 index 0000000000000..d2b618e591f19 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumTypeDefs Method" +title: "IMetaDataImport::EnumTypeDefs Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumTypeDefs" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumTypeDefs" +helpviewer_keywords: + - "EnumTypeDefs method [.NET Framework metadata]" + - "IMetaDataImport::EnumTypeDefs method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumTypeDefs Method + +Enumerates TypeDef tokens representing all types within the current scope. + +## Syntax + +```cpp +HRESULT EnumTypeDefs ( + [out] HCORENUM *phEnum, + [in] mdTypeDef rTypeDefs[], + [in] ULONG cMax, + [out] ULONG *pcTypeDefs +); +``` + +## Parameters + + `phEnum` + [out] A pointer to the new enumerator. This must be NULL for the first call of this method. + + `rTypeDefs` + [in] The array used to store the TypeDef tokens. + + `cMax` + [in] The maximum size of the `rTypeDefs` array. + + `pcTypeDefs` + [out] The number of TypeDef tokens returned in `rTypeDefs`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumTypeDefs` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTypeDefs` is zero.| + +## Remarks + + The TypeDef token represents a type such as a class or an interface, as well as any type added via an extensibility mechanism. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md new file mode 100644 index 0000000000000..5153cfd089fa3 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumTypeRefs Method" +title: "IMetaDataImport::EnumTypeRefs Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumTypeRefs" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumTypeRefs" +helpviewer_keywords: + - "EnumTypeRefs method [.NET Framework metadata]" + - "IMetaDataImport::EnumTypeRefs method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumTypeRefs Method + +Enumerates TypeRef tokens defined in the current metadata scope. + +## Syntax + +```cpp +HRESULT EnumTypeRefs ( + [in, out] HCORENUM *phEnum, + [out] mdTypeRef rTypeRefs[], + [in] ULONG cMax, + [out] ULONG *pcTypeRefs +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `rTypeRefs` + [out] The array used to store the TypeRef tokens. + + `cMax` + [in] The maximum size of the `rTypeRefs` array. + + `pcTypeRefs` + [out] A pointer to the number of TypeRef tokens returned in `rTypeRefs`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumTypeRefs` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTypeRefs` is zero.| + +## Remarks + + A TypeRef token represents a reference to a type. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md new file mode 100644 index 0000000000000..8661016095815 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumTypeSpecs Method" +title: "IMetaDataImport::EnumTypeSpecs Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumTypeSpecs" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumTypeSpecs" +helpviewer_keywords: + - "EnumTypeSpecs method [.NET Framework metadata]" + - "IMetaDataImport::EnumTypeSpecs method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumTypeSpecs Method + +Enumerates TypeSpec tokens defined in the current metadata scope. + +## Syntax + +```cpp +HRESULT EnumTypeSpecs ( + [in, out] HCORENUM *phEnum, + [out] mdTypeSpec rTypeSpecs[], + [in] ULONG cMax, + [out] ULONG *pcTypeSpecs +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This value must be NULL for the first call of this method. + + `rTypeSpecs` + [out] The array used to store the TypeSpec tokens. + + `cMax` + [in] The maximum size of the `rTypeSpecs` array. + + `pcTypeSpecs` + [out] The number of TypeSpec tokens returned in `rTypeSpecs`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumTypeSpecs` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTypeSpecs` is zero.| + +## Remarks + + The TypeSpec tokens are created by the [IMetaDataEmit::GetTokenFromTypeSpec](imetadataemit-gettokenfromtypespec-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md index 35fada596c235..f3c30dcc24b4d 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md @@ -2,73 +2,72 @@ description: "Learn more about: IMetaDataImport::EnumUnresolvedMethods Method" title: "IMetaDataImport::EnumUnresolvedMethods Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumUnresolvedMethods" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumUnresolvedMethods" -helpviewer_keywords: +helpviewer_keywords: - "EnumUnresolvedMethods method [.NET Framework metadata]" - "IMetaDataImport::EnumUnresolvedMethods method [.NET Framework metadata]" -ms.assetid: eb3187d7-74cf-44b1-aeeb-7a8d2b60e3b7 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumUnresolvedMethods Method -Enumerates MemberDef tokens representing the unresolved methods in the current metadata scope. - -## Syntax - -```cpp -HRESULT EnumUnresolvedMethods ( - [in, out] HCORENUM *phEnum, - [out] mdToken rMethods[], - [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `rMethods` - [out] The array used to store the MemberDef tokens. - - `cMax` - [in] The maximum size of the `rMethods` array. - - `pcTokens` - [out] The number of MemberDef tokens returned in `rMethods`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumUnresolvedMethods` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTokens` is zero.| - -## Remarks - - An unresolved method is one that has been declared but not implemented. A method is included in the enumeration if the method is marked `miForwardRef` and either `mdPinvokeImpl` or `miRuntime` is set to zero. In other words, an unresolved method is a class method that is marked `miForwardRef` but which is not implemented in unmanaged code (reached via PInvoke) nor implemented internally by the runtime itself - - The enumeration excludes all methods that are defined either at module scope (globals) or in interfaces or abstract classes. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Enumerates MemberDef tokens representing the unresolved methods in the current metadata scope. + +## Syntax + +```cpp +HRESULT EnumUnresolvedMethods ( + [in, out] HCORENUM *phEnum, + [out] mdToken rMethods[], + [in] ULONG cMax, + [out] ULONG *pcTokens +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `rMethods` + [out] The array used to store the MemberDef tokens. + + `cMax` + [in] The maximum size of the `rMethods` array. + + `pcTokens` + [out] The number of MemberDef tokens returned in `rMethods`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumUnresolvedMethods` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTokens` is zero.| + +## Remarks + + An unresolved method is one that has been declared but not implemented. A method is included in the enumeration if the method is marked `miForwardRef` and either `mdPinvokeImpl` or `miRuntime` is set to zero. In other words, an unresolved method is a class method that is marked `miForwardRef` but which is not implemented in unmanaged code (reached via PInvoke) nor implemented internally by the runtime itself + + The enumeration excludes all methods that are defined either at module scope (globals) or in interfaces or abstract classes. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md new file mode 100644 index 0000000000000..3aa26aed16aff --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport::EnumUserStrings Method" +title: "IMetaDataImport::EnumUserStrings Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.EnumUserStrings" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::EnumUserStrings" +helpviewer_keywords: + - "IMetaDataImport::EnumUserStrings method [.NET Framework metadata]" + - "EnumUserStrings method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::EnumUserStrings Method + +Enumerates String tokens representing hard-coded strings in the current metadata scope. + +## Syntax + +```cpp +HRESULT EnumUserStrings ( + [in, out] HCORENUM *phEnum, + [out] mdString rStrings[], + [in] ULONG cMax, + [out] ULONG *pcStrings +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. + + `rStrings` + [out] The array used to store the String tokens. + + `cMax` + [in] The maximum size of the `rStrings` array. + + `pcStrings` + [out] The number of String tokens returned in `rStrings`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumUserStrings` returned successfully.| +|`S_FALSE`|There are no tokens to enumerate. In that case, `pcStrings` is zero.| + +## Remarks + + The String tokens are created by the [IMetaDataEmit::DefineUserString](imetadataemit-defineuserstring-method.md) method. This method is designed to be used by a metadata browser rather than by a compiler. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-findfield-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findfield-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md index d4c96ba30ca8e..61bfdc0fb1246 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-findfield-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataImport::FindField Method" title: "IMetaDataImport::FindField Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.FindField" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::FindField" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::FindField method [.NET Framework metadata]" - "FindField method [.NET Framework metadata]" -ms.assetid: 38cd4e16-fbb2-471c-aa73-ac51a1931ad2 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::FindField Method -Gets a pointer to the FieldDef token for the field that is enclosed by the specified and that has the specified name and metadata signature. - -## Syntax - -```cpp -HRESULT FindField ( - [in] mdTypeDef td, - [in] LPCWSTR szName, - [in] PCCOR_SIGNATURE pvSigBlob, - [in] ULONG cbSigBlob, - [out] mdFieldDef *pmb -); -``` - -## Parameters - - `td` - [in] The TypeDef token for the class or interface that encloses the field to search for. If this value is `mdTokenNil`, the lookup is done for a global variable. - - `szName` - [in] The name of the field to search for. - - `pvSigBlob` - [in] A pointer to the binary metadata signature of the field. - - `cbSigBlob` - [in] The size in bytes of `pvSigBlob`. - - `pmb` - [out] A pointer to the matching FieldDef token. - -## Remarks - - You specify the field using its enclosing class or interface (`td`), its name (`szName`), and optionally its signature (`pvSigBlob`). - - The signature passed to `FindField` must have been generated in the current scope, because signatures are bound to a particular scope. A signature can embed a token that identifies the enclosing class or value type. (The token is an index into the local TypeDef table). You cannot build a run-time signature outside the context of the current scope and use that signature as input to `FindField`. - - `FindField` finds only fields that were defined directly in the class or interface; it does not find inherited fields. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a pointer to the FieldDef token for the field that is enclosed by the specified and that has the specified name and metadata signature. + +## Syntax + +```cpp +HRESULT FindField ( + [in] mdTypeDef td, + [in] LPCWSTR szName, + [in] PCCOR_SIGNATURE pvSigBlob, + [in] ULONG cbSigBlob, + [out] mdFieldDef *pmb +); +``` + +## Parameters + + `td` + [in] The TypeDef token for the class or interface that encloses the field to search for. If this value is `mdTokenNil`, the lookup is done for a global variable. + + `szName` + [in] The name of the field to search for. + + `pvSigBlob` + [in] A pointer to the binary metadata signature of the field. + + `cbSigBlob` + [in] The size in bytes of `pvSigBlob`. + + `pmb` + [out] A pointer to the matching FieldDef token. + +## Remarks + + You specify the field using its enclosing class or interface (`td`), its name (`szName`), and optionally its signature (`pvSigBlob`). + + The signature passed to `FindField` must have been generated in the current scope, because signatures are bound to a particular scope. A signature can embed a token that identifies the enclosing class or value type. (The token is an index into the local TypeDef table). You cannot build a run-time signature outside the context of the current scope and use that signature as input to `FindField`. + + `FindField` finds only fields that were defined directly in the class or interface; it does not find inherited fields. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-findmember-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md similarity index 61% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findmember-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md index fc39a269b14f0..58bdbe2db6326 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-findmember-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md @@ -2,75 +2,74 @@ description: "Learn more about: IMetaDataImport::FindMember Method" title: "IMetaDataImport::FindMember Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.FindMember" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::FindMember" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::FindMember method [.NET Framework metadata]" - "FindMember method [.NET Framework metadata]" -ms.assetid: ad32fb84-c2b6-41cd-888d-787ff3a90449 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::FindMember Method -Gets a pointer to the MemberDef token for field or method that is enclosed by the specified and that has the specified name and metadata signature. - -## Syntax - -```cpp -HRESULT FindMember ( - [in] mdTypeDef td, +Gets a pointer to the MemberDef token for field or method that is enclosed by the specified and that has the specified name and metadata signature. + +## Syntax + +```cpp +HRESULT FindMember ( + [in] mdTypeDef td, [in] LPCWSTR szName, [in] PCCOR_SIGNATURE pvSigBlob, [in] ULONG cbSigBlob, - [out] mdToken *pmb -); -``` - -## Parameters - - `td` - [in] The TypeDef token for the class or interface that encloses the member to search for. If this value is `mdTokenNil`, the lookup is done for a global-variable or global-function. - - `szName` - [in] The name of the member to search for. - - `pvSigBlob` - [in] A pointer to the binary metadata signature of the member. - - `cbSigBlob` - [in] The size in bytes of `pvSigBlob`. - - `pmb` - [out] A pointer to the matching MemberDef token. - -## Remarks - - You specify the member using its enclosing class or interface (`td`), its name (`szName`), and optionally its signature (`pvSigBlob`). There might be multiple members with the same name in a class or interface. In that case, pass the member's signature to find the unique match. - - The signature passed to `FindMember` must have been generated in the current scope, because signatures are bound to a particular scope. A signature can embed a token that identifies the enclosing class or value type. The token is an index into the local TypeDef table. You cannot build a run-time signature outside the context of the current scope and use that signature as input to input to `FindMember`. - - `FindMember` finds only members that were defined directly in the class or interface; it does not find inherited members. - + [out] mdToken *pmb +); +``` + +## Parameters + + `td` + [in] The TypeDef token for the class or interface that encloses the member to search for. If this value is `mdTokenNil`, the lookup is done for a global-variable or global-function. + + `szName` + [in] The name of the member to search for. + + `pvSigBlob` + [in] A pointer to the binary metadata signature of the member. + + `cbSigBlob` + [in] The size in bytes of `pvSigBlob`. + + `pmb` + [out] A pointer to the matching MemberDef token. + +## Remarks + + You specify the member using its enclosing class or interface (`td`), its name (`szName`), and optionally its signature (`pvSigBlob`). There might be multiple members with the same name in a class or interface. In that case, pass the member's signature to find the unique match. + + The signature passed to `FindMember` must have been generated in the current scope, because signatures are bound to a particular scope. A signature can embed a token that identifies the enclosing class or value type. The token is an index into the local TypeDef table. You cannot build a run-time signature outside the context of the current scope and use that signature as input to input to `FindMember`. + + `FindMember` finds only members that were defined directly in the class or interface; it does not find inherited members. + > [!NOTE] -> `FindMember` is a helper method. It calls [IMetaDataImport::FindMethod](imetadataimport-findmethod-method.md); if that call does not find a match, `FindMember` then calls [IMetaDataImport::FindField](imetadataimport-findfield-method.md). - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +> `FindMember` is a helper method. It calls [IMetaDataImport::FindMethod](imetadataimport-findmethod-method.md); if that call does not find a match, `FindMember` then calls [IMetaDataImport::FindField](imetadataimport-findfield-method.md). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-findmemberref-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md similarity index 63% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findmemberref-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md index ac77570bf732c..3e6bc3dbb1642 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-findmemberref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataImport::FindMemberRef Method" title: "IMetaDataImport::FindMemberRef Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.FindMemberRef" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::FindMemberRef" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::FindMemberRef method [.NET Framework metadata]" - "FindMemberRef method [.NET Framework metadata]" -ms.assetid: 1ccda329-d752-4d89-abe8-511af3c3f4c9 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::FindMemberRef Method -Gets a pointer to the MemberRef token for the member reference that is enclosed by the specified and that has the specified name and metadata signature. - -## Syntax - -```cpp -HRESULT FindMemberRef ( - [in] mdTypeRef td, +Gets a pointer to the MemberRef token for the member reference that is enclosed by the specified and that has the specified name and metadata signature. + +## Syntax + +```cpp +HRESULT FindMemberRef ( + [in] mdTypeRef td, [in] LPCWSTR szName, [in] PCCOR_SIGNATURE pvSigBlob, [in] ULONG cbSigBlob, - [out] mdMemberRef *pmr -); -``` - -## Parameters - - `td` - [in] The TypeRef token for the class or interface that encloses the member reference to search for. If this value is `mdTokenNil`, the lookup is done for a global variable or a global-function reference. - - `szName` - [in] The name of the member reference to search for. - - `pvSigBlob` - [in] A pointer to the binary metadata signature of the member reference. - - `cbSigBlob` - [in] The size in bytes of `pvSigBlob`. - - `pmr` - [out] A pointer to the matching MemberRef token. - -## Remarks - - You specify the member using its enclosing class or interface (`td`), its name (`szName`), and optionally its signature (`pvSigBlob`). - - The signature passed to `FindMemberRef` must have been generated in the current scope, because signatures are bound to a particular scope. A signature can embed a token that identifies the enclosing class or value type. The token is an index into the local TypeDef table. You cannot build a run-time signature outside the context of the current scope and use that signature as input to `FindMemberRef`. - - `FindMemberRef` finds only member references that were defined directly in the class or interface; it does not find inherited member references. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] mdMemberRef *pmr +); +``` + +## Parameters + + `td` + [in] The TypeRef token for the class or interface that encloses the member reference to search for. If this value is `mdTokenNil`, the lookup is done for a global variable or a global-function reference. + + `szName` + [in] The name of the member reference to search for. + + `pvSigBlob` + [in] A pointer to the binary metadata signature of the member reference. + + `cbSigBlob` + [in] The size in bytes of `pvSigBlob`. + + `pmr` + [out] A pointer to the matching MemberRef token. + +## Remarks + + You specify the member using its enclosing class or interface (`td`), its name (`szName`), and optionally its signature (`pvSigBlob`). + + The signature passed to `FindMemberRef` must have been generated in the current scope, because signatures are bound to a particular scope. A signature can embed a token that identifies the enclosing class or value type. The token is an index into the local TypeDef table. You cannot build a run-time signature outside the context of the current scope and use that signature as input to `FindMemberRef`. + + `FindMemberRef` finds only member references that were defined directly in the class or interface; it does not find inherited member references. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-findmethod-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md similarity index 60% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findmethod-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md index 71ccc70e71cb1..8a63a9dcae378 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-findmethod-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataImport::FindMethod Method" title: "IMetaDataImport::FindMethod Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.FindMethod" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::FindMethod" -helpviewer_keywords: +helpviewer_keywords: - "FindMethod method [.NET Framework metadata]" - "IMetaDataImport::FindMethod method [.NET Framework metadata]" -ms.assetid: 0f9bde1d-e306-438d-941b-d0925b322304 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::FindMethod Method -Gets a pointer to the MethodDef token for the method that is enclosed by the specified and that has the specified name and metadata signature. - -## Syntax - -```cpp -HRESULT FindMethod ( - [in] mdTypeDef td, +Gets a pointer to the MethodDef token for the method that is enclosed by the specified and that has the specified name and metadata signature. + +## Syntax + +```cpp +HRESULT FindMethod ( + [in] mdTypeDef td, [in] LPCWSTR szName, [in] PCCOR_SIGNATURE pvSigBlob, [in] ULONG cbSigBlob, - [out] mdMethodDef *pmb -); -``` - -## Parameters - - `td` - [in] The `mdTypeDef` token for the type (a class or interface) that encloses the member to search for. If this value is `mdTokenNil`, then the lookup is done for a global function. - - `szName` - [in] The name of the method to search for. - - `pvSigBlob` - [in] A pointer to the binary metadata signature of the method. - - `cbSigBlob` - [in] The size in bytes of `pvSigBlob`. - - `pmb` - [out] A pointer to the matching MethodDef token. - -## Remarks - - You specify the method using its enclosing class or interface (`td`), its name (`szName`), and optionally its signature (`pvSigBlob`). There might be multiple methods with the same name in a class or interface. In that case, pass the method's signature to find the unique match. - - The signature passed to `FindMethod` must have been generated in the current scope, because signatures are bound to a particular scope. A signature can embed a token that identifies the enclosing class or value type. The token is an index into the local TypeDef table. You cannot build a run-time signature outside the context of the current scope and use that signature as input to input to `FindMethod`. - - `FindMethod` finds only methods that were defined directly in the class or interface; it does not find inherited methods. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] mdMethodDef *pmb +); +``` + +## Parameters + + `td` + [in] The `mdTypeDef` token for the type (a class or interface) that encloses the member to search for. If this value is `mdTokenNil`, then the lookup is done for a global function. + + `szName` + [in] The name of the method to search for. + + `pvSigBlob` + [in] A pointer to the binary metadata signature of the method. + + `cbSigBlob` + [in] The size in bytes of `pvSigBlob`. + + `pmb` + [out] A pointer to the matching MethodDef token. + +## Remarks + + You specify the method using its enclosing class or interface (`td`), its name (`szName`), and optionally its signature (`pvSigBlob`). There might be multiple methods with the same name in a class or interface. In that case, pass the method's signature to find the unique match. + + The signature passed to `FindMethod` must have been generated in the current scope, because signatures are bound to a particular scope. A signature can embed a token that identifies the enclosing class or value type. The token is an index into the local TypeDef table. You cannot build a run-time signature outside the context of the current scope and use that signature as input to input to `FindMethod`. + + `FindMethod` finds only methods that were defined directly in the class or interface; it does not find inherited methods. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md new file mode 100644 index 0000000000000..011bf8f629b38 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: IMetaDataImport::FindTypeDefByName Method" +title: "IMetaDataImport::FindTypeDefByName Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.FindTypeDefByName" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::FindTypeDefByName" +helpviewer_keywords: + - "FindTypeDefByName method [.NET Framework metadata]" + - "IMetaDataImport::FindTypeDefByName method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::FindTypeDefByName Method + +Gets a pointer to the TypeDef metadata token for the with the specified name. + +## Syntax + +```cpp +HRESULT FindTypeDefByName + [in] LPCWSTR szTypeDef, + [in] mdToken tkEnclosingClass, + [out] mdTypeDef *ptd +); +``` + +## Parameters + + `szTypeDef` + [in] The name of the type for which to get the TypeDef token. + + `tkEnclosingClass` + [in] A TypeDef or TypeRef token representing the enclosing class. If the type to find is not a nested class, set this value to NULL. + + `ptd` + [out] A pointer to the matching TypeDef token. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md new file mode 100644 index 0000000000000..47e6d4e772651 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: IMetaDataImport::FindTypeRef Method" +title: "IMetaDataImport::FindTypeRef Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.FindTypeRef" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::FindTypeRef" +helpviewer_keywords: + - "IMetaDataImport::FindTypeRef method [.NET Framework metadata]" + - "FindTypeRef method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::FindTypeRef Method + +Gets a pointer to the TypeRef token for the reference that is in the specified scope and that has the specified name. + +## Syntax + +```cpp +HRESULT FindTypeRef ( + [in] mdToken tkResolutionScope, + [in] LPCWSTR szName, + [out] mdTypeRef *ptr +); +``` + +## Parameters + + `tkResolutionScope` + [in] A ModuleRef, AssemblyRef, or TypeRef token that specifies the module, assembly, or type, respectively, in which the type reference is defined. + + `szName` + [in] The name of the type reference to search for. + + `ptr` + [out] A pointer to the matching TypeRef token. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md new file mode 100644 index 0000000000000..2b9fb016f4212 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md @@ -0,0 +1,69 @@ +--- +description: "Learn more about: IMetaDataImport::GetClassLayout Method" +title: "IMetaDataImport::GetClassLayout Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetClassLayout" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetClassLayout" +helpviewer_keywords: + - "IMetaDataImport::GetClassLayout method [.NET Framework metadata]" + - "GetClassLayout method, IMetaDataImport interface [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetClassLayout Method + +Gets layout information for the class referenced by the specified TypeDef token. + +## Syntax + +```cpp +HRESULT GetClassLayout ( + [in] mdTypeDef td, + [out] DWORD *pdwPackSize, + [out] COR_FIELD_OFFSET rFieldOffset[], + [in] ULONG cMax, + [out] ULONG *pcFieldOffset, + [out] ULONG *pulClassSize +); +``` + +## Parameters + + `td` + [in] The TypeDef token for the class with the layout to return. + + `pdwPackSize` + [out] One of the values 1, 2, 4, 8, or 16, representing the pack size of the class. + + `rFieldOffset` + [out] An array of [COR_FIELD_OFFSET](cor-field-offset-structure.md) values. + + `cMax` + [in] The maximum size of the `rFieldOffset` array. + + `pcFieldOffset` + [out] The number of elements returned in `rFieldOffset`. + + `pulClassSize` + [out] The size in bytes of the class represented by `td`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md index 676a8d3abc17c..364967751bee9 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataImport::GetCustomAttributeByName Method" title: "IMetaDataImport::GetCustomAttributeByName Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetCustomAttributeByName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetCustomAttributeByName" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetCustomAttributeByName method [.NET Framework metadata]" - "GetCustomAttributeByName method [.NET Framework metadata]" -ms.assetid: 909aa530-2e3b-4d0a-a38a-a2750e535d7d -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetCustomAttributeByName Method -Gets the custom attribute, given its name and owner. - -## Syntax - -```cpp -HRESULT GetCustomAttributeByName ( - [in] mdToken tkObj, - [in] LPCWSTR szName, - [out] const void **ppData, - [out] ULONG *pcbData -); -``` - -## Parameters - - `tkObj` - [in] A metadata token representing the object that owns the custom attribute. - - `szName` - [in] The name of the custom attribute. - - `ppData` - [out] A pointer to an array of data that is the value of the custom attribute. - - `pcbData` - [out] The size in bytes of the data returned in *`ppData`. - -## Remarks - - It is legal to define multiple custom attributes for the same owner; they may even have the same name. However, `GetCustomAttributeByName` returns only one instance. (`GetCustomAttributeByName` returns the first instance that it encounters.) To find all instances of a custom attribute, call the [IMetaDataImport::EnumCustomAttributes](imetadataimport-enumcustomattributes-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the custom attribute, given its name and owner. + +## Syntax + +```cpp +HRESULT GetCustomAttributeByName ( + [in] mdToken tkObj, + [in] LPCWSTR szName, + [out] const void **ppData, + [out] ULONG *pcbData +); +``` + +## Parameters + + `tkObj` + [in] A metadata token representing the object that owns the custom attribute. + + `szName` + [in] The name of the custom attribute. + + `ppData` + [out] A pointer to an array of data that is the value of the custom attribute. + + `pcbData` + [out] The size in bytes of the data returned in *`ppData`. + +## Remarks + + It is legal to define multiple custom attributes for the same owner; they may even have the same name. However, `GetCustomAttributeByName` returns only one instance. (`GetCustomAttributeByName` returns the first instance that it encounters.) To find all instances of a custom attribute, call the [IMetaDataImport::EnumCustomAttributes](imetadataimport-enumcustomattributes-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md index 84fec52724934..88271da3e6b42 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IMetaDataImport::GetCustomAttributeProps Method" title: "IMetaDataImport::GetCustomAttributeProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetCustomAttributeProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetCustomAttributeProps" -helpviewer_keywords: +helpviewer_keywords: - "GetCustomAttributeProps method [.NET Framework metadata]" - "IMetaDataImport::GetCustomAttributeProps method [.NET Framework metadata]" -ms.assetid: 6eefb243-a281-41c1-bcdc-7e17513bc446 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetCustomAttributeProps Method -Gets the value of the custom attribute, given its metadata token. - -## Syntax - -```cpp -HRESULT GetCustomAttributeProps ( - [in] mdCustomAttribute cv, - [out, optional] mdToken *ptkObj, - [out, optional] mdToken *ptkType, - [out, optional] void const **ppBlob, - [out, optional] ULONG *pcbSize -); -``` - -## Parameters - - `cv` - [in] A metadata token that represents the custom attribute to be retrieved. - - `ptkObj` - [out, optional] A metadata token representing the object that the custom attribute modifies. This value can be any type of metadata token except `mdCustomAttribute`. - - `ptkType` - [out, optional] An `mdMethodDef` or `mdMemberRef` metadata token representing the of the returned custom attribute. - - `ppBlob` - [out, optional] A pointer to an array of data that is the value of the custom attribute. - - `pcbSize` - [out, optional] The size in bytes of the data returned in *`ppBlob`. - -## Remarks - - A custom attribute is stored as an array of data, the format which is understood by the metadata engine. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the value of the custom attribute, given its metadata token. + +## Syntax + +```cpp +HRESULT GetCustomAttributeProps ( + [in] mdCustomAttribute cv, + [out, optional] mdToken *ptkObj, + [out, optional] mdToken *ptkType, + [out, optional] void const **ppBlob, + [out, optional] ULONG *pcbSize +); +``` + +## Parameters + + `cv` + [in] A metadata token that represents the custom attribute to be retrieved. + + `ptkObj` + [out, optional] A metadata token representing the object that the custom attribute modifies. This value can be any type of metadata token except `mdCustomAttribute`. + + `ptkType` + [out, optional] An `mdMethodDef` or `mdMemberRef` metadata token representing the of the returned custom attribute. + + `ppBlob` + [out, optional] A pointer to an array of data that is the value of the custom attribute. + + `pcbSize` + [out, optional] The size in bytes of the data returned in *`ppBlob`. + +## Remarks + + A custom attribute is stored as an array of data, the format which is understood by the metadata engine. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-geteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataimport-geteventprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md index 7bfd0019f048d..c22819a7b261e 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-geteventprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md @@ -2,93 +2,92 @@ description: "Learn more about: IMetaDataImport::GetEventProps Method" title: "IMetaDataImport::GetEventProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetEventProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetEventProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetEventProps method [.NET Framework metadata]" - "GetEventProps method [.NET Framework metadata]" -ms.assetid: 5eaf3b4a-92b7-4d5b-97e0-1e83721e0052 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetEventProps Method -Gets metadata information for the event represented by the specified event token, including the declaring type, the add and remove methods for delegates, and any flags and other associated data. - -## Syntax - -```cpp -HRESULT GetEventProps ( - [in] mdEvent ev, +Gets metadata information for the event represented by the specified event token, including the declaring type, the add and remove methods for delegates, and any flags and other associated data. + +## Syntax + +```cpp +HRESULT GetEventProps ( + [in] mdEvent ev, [out] mdTypeDef *pClass, [out] LPCWSTR szEvent, [in] ULONG cchEvent, [out] ULONG *pchEvent, - [out] DWORD *pdwEventFlags, - [out] mdToken *ptkEventType, + [out] DWORD *pdwEventFlags, + [out] mdToken *ptkEventType, [out] mdMethodDef *pmdAddOn, [out] mdMethodDef *pmdRemoveOn, [out] mdMethodDef *pmdFire, [out] mdMethodDef rmdOtherMethod[], - [in] ULONG cMax, - [out] ULONG *pcOtherMethod -); -``` - -## Parameters - - `ev` - [in] The event metadata token representing the event to get metadata for. - - `pClass` - [out] A pointer to the TypeDef token representing the class that declares the event. - - `szEvent` - [out] The name of the event referenced by `ev`. - - `pchEvent` - [in] The requested length in wide characters of `szEvent`. - - `pdwEventFlags` - [out] The returned length in wide characters of `szEvent`. - - `ptkEventType` - [out] A pointer to a TypeRef or TypeDef metadata token representing the type of the event. - - `pmdAddOn` - [out] A pointer to the metadata token representing the method that adds handlers for the event. - - `pmdRemoveOn` - [out] A pointer to the metadata token representing the method that removes handlers for the event. - - `pmdFire` - [out] A pointer to the metadata token representing the method that raises the event. - - `rmdOtherMethod` - [out] An array of token pointers to other methods associated with the event. - - `cMax` - [in] The maximum size of the `rmdOtherMethod` array. - - `pcOtherMethod` - [out] The number of tokens returned in `rmdOtherMethod`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] ULONG cMax, + [out] ULONG *pcOtherMethod +); +``` + +## Parameters + + `ev` + [in] The event metadata token representing the event to get metadata for. + + `pClass` + [out] A pointer to the TypeDef token representing the class that declares the event. + + `szEvent` + [out] The name of the event referenced by `ev`. + + `pchEvent` + [in] The requested length in wide characters of `szEvent`. + + `pdwEventFlags` + [out] The returned length in wide characters of `szEvent`. + + `ptkEventType` + [out] A pointer to a TypeRef or TypeDef metadata token representing the type of the event. + + `pmdAddOn` + [out] A pointer to the metadata token representing the method that adds handlers for the event. + + `pmdRemoveOn` + [out] A pointer to the metadata token representing the method that removes handlers for the event. + + `pmdFire` + [out] A pointer to the metadata token representing the method that raises the event. + + `rmdOtherMethod` + [out] An array of token pointers to other methods associated with the event. + + `cMax` + [in] The maximum size of the `rmdOtherMethod` array. + + `pcOtherMethod` + [out] The number of tokens returned in `rmdOtherMethod`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md index 753375bf7dc76..966f89e8923a0 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport::GetFieldMarshal Method" title: "IMetaDataImport::GetFieldMarshal Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetFieldMarshal" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetFieldMarshal" -helpviewer_keywords: +helpviewer_keywords: - "GetFieldMarshal method [.NET Framework metadata]" - "IMetaDataImport::GetFieldMarshal method [.NET Framework metadata]" -ms.assetid: 4e2d88c6-8a3a-4fbe-900b-b4f4c06bf6bf -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetFieldMarshal Method -Gets a pointer to the native, unmanaged type of the field represented by the specified field metadata token. - -## Syntax - -```cpp -HRESULT GetFieldMarshal ( +Gets a pointer to the native, unmanaged type of the field represented by the specified field metadata token. + +## Syntax + +```cpp +HRESULT GetFieldMarshal ( [in] mdToken tk, - [out] PCCOR_SIGNATURE *ppvNativeType, + [out] PCCOR_SIGNATURE *ppvNativeType, [out] ULONG *pcbNativeType -); -``` - -## Parameters - - `tk` - [in] The metadata token that represents the field to get interop marshalling information for. - - `ppvNativeType` - [out] A pointer to the metadata signature of the field's native type. - - `pcbNativeType` - [out] The size in bytes of `ppvNativeType`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `tk` + [in] The metadata token that represents the field to get interop marshalling information for. + + `ppvNativeType` + [out] A pointer to the metadata signature of the field's native type. + + `pcbNativeType` + [out] The size in bytes of `ppvNativeType`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md new file mode 100644 index 0000000000000..9544484dfeebc --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md @@ -0,0 +1,89 @@ +--- +description: "Learn more about: IMetaDataImport::GetFieldProps Method" +title: "IMetaDataImport::GetFieldProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetFieldProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetFieldProps" +helpviewer_keywords: + - "IMetaDataImport::GetFieldProps method [.NET Framework metadata]" + - "GetFieldProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetFieldProps Method + +Gets metadata associated with the field referenced by the specified FieldDef token. + +## Syntax + +```cpp +HRESULT GetFieldProps ( + [in] mdFieldDef mb, + [out] mdTypeDef *pClass, + [out] LPWSTR szField, + [in] ULONG cchField, + [out] ULONG *pchField, + [out] DWORD *pdwAttr, + [out] PCCOR_SIGNATURE *ppvSigBlob, + [out] ULONG *pcbSigBlob, + [out] DWORD *pdwCPlusTypeFlag, + [out] UVCP_CONSTANT *ppValue, + [out] ULONG *pcchValue +); +``` + +## Parameters + + `mb` + [in] A FieldDef token that represents the field to get associated metadata for. + + `pClass` + [out] A pointer to a TypeDef token that represents the type of the class that the field belongs to. + + `szField` + [out] The name of the field. + + `cchField` + [in] The size in wide characters of the buffer for *szField*. + + `pchField` + [out] The actual size of the returned buffer. + + `pdwAttr` + [out] Flags associated with the field's metadata. + + `ppvSigBlob` + [out] A pointer to the binary metadata value that describes the field. + + `pcbSigBlob` + [out] The size in bytes of `ppvSigBlob`. + + `pdwCPlusTypeFlag` + [out] A flag that specifies the value type of the field. + + `ppValue` + [out] A constant value for the field. + + `pcchValue` + [out] The size in chars of `ppValue`, or zero if no string exists. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md similarity index 71% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md index e89cd583dafb2..5f918d724de94 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md @@ -2,45 +2,44 @@ description: "Learn more about: IMetaDataImport::GetInterfaceImplProps Method" title: "IMetaDataImport::GetInterfaceImplProps Method" ms.date: "02/25/2019" -api_name: +api_name: - "IMetaDataImport.GetInterfaceImplProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetInterfaceImplProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetInterfaceImplProps method [.NET Framework metadata]" - "GetInterfaceImpProps method [.NET Framework metadata]" -ms.assetid: be3f5985-b1e4-4036-8602-c16e8508d4af -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetInterfaceImplProps Method Gets a pointer to the metadata tokens for the that implements the specified method, and for the interface that declares that method. - -## Syntax - -```cpp -HRESULT GetInterfaceImplProps ( - [in] mdInterfaceImpl iiImpl, - [out] mdTypeDef *pClass, - [out] mdToken *ptkIface -); -``` - -## Parameters - - `iiImpl` - [in] The metadata token representing the method to return the class and interface tokens for. - - `pClass` - [out] The metadata token representing the class that implements the method. - - `ptkIface` - [out] The metadata token representing the interface that defines the implemented method. + +## Syntax + +```cpp +HRESULT GetInterfaceImplProps ( + [in] mdInterfaceImpl iiImpl, + [out] mdTypeDef *pClass, + [out] mdToken *ptkIface +); +``` + +## Parameters + + `iiImpl` + [in] The metadata token representing the method to return the class and interface tokens for. + + `pClass` + [out] The metadata token representing the class that implements the method. + + `ptkIface` + [out] The metadata token representing the interface that defines the implemented method. ## Remarks @@ -69,17 +68,17 @@ Recall, the token is a 4-byte value: - The upper byte holds the token type – 0x09 for `mdtInterfaceImpl`. `GetInterfaceImplProps` returns the information held in the row whose token you provide in the `iImpl` argument. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md similarity index 56% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md index 23c8feb18313e..0c968359a4508 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md @@ -2,96 +2,95 @@ description: "Learn more about: IMetaDataImport::GetMemberProps Method" title: "IMetaDataImport::GetMemberProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetMemberProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetMemberProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetMemberProps method [.NET Framework metadata]" - "GetMemberProps method [.NET Framework metadata]" -ms.assetid: 42790918-4142-4938-b8f4-a56979a55846 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetMemberProps Method Gets information stored in the metadata for a specified member definition, including the name, binary signature, and relative virtual address, of the member referenced by the specified metadata token. This is a simple helper method: if *mb* is a MethodDef, then **GetMethodProps** is called; if *mb* is a FieldDef, then **GetFieldProps** is called. See these other methods for details. - -## Syntax - -```cpp -HRESULT GetMemberProps ( + +## Syntax + +```cpp +HRESULT GetMemberProps ( [in] mdToken mb, - [out] mdTypeDef *pClass, + [out] mdTypeDef *pClass, [out] LPWSTR szMember, [in] ULONG cchMember, [out] ULONG *pchMember, - [out] DWORD *pdwAttr, + [out] DWORD *pdwAttr, [out] PCCOR_SIGNATURE *ppvSigBlob, [out] ULONG *pcbSigBlob, [out] ULONG *pulCodeRVA, [out] DWORD *pdwImplFlags, [out] DWORD *pdwCPlusTypeFlag, - [out] UVCP_CONSTANT *ppValue, - [out] ULONG *pcchValue -); -``` - -## Parameters - - `mb` - [in] The token that references the member to get the associated metadata for. - - `pClass` - [out] A pointer to the metadata token that represents the class of the member. - - `szMember` - [out] The name of the member. - - `cchMember` - [in] The size in wide characters of the `szMember` buffer. - - `pchMember` - [out] The size in wide characters of the returned name. - - `pdwAttr` - [out] Any flag values applied to the member. - - `ppvSigBlob` - [out] A pointer to the binary metadata signature of the member. - - `pcbSigBlob` - [out] The size in bytes of `ppvSigBlob`. - - `pulCodeRVA` - [out] A pointer to the relative virtual address of the member. - - `pdwImplFlags` - [out] Any method implementation flags associated with the member. - - `pdwCPlusTypeFlag` + [out] UVCP_CONSTANT *ppValue, + [out] ULONG *pcchValue +); +``` + +## Parameters + + `mb` + [in] The token that references the member to get the associated metadata for. + + `pClass` + [out] A pointer to the metadata token that represents the class of the member. + + `szMember` + [out] The name of the member. + + `cchMember` + [in] The size in wide characters of the `szMember` buffer. + + `pchMember` + [out] The size in wide characters of the returned name. + + `pdwAttr` + [out] Any flag values applied to the member. + + `ppvSigBlob` + [out] A pointer to the binary metadata signature of the member. + + `pcbSigBlob` + [out] The size in bytes of `ppvSigBlob`. + + `pulCodeRVA` + [out] A pointer to the relative virtual address of the member. + + `pdwImplFlags` + [out] Any method implementation flags associated with the member. + + `pdwCPlusTypeFlag` [out] A flag that marks a . It is one of the `ELEMENT_TYPE_*` values. - - `ppValue` - [out] A constant string value returned by this member. - - `pcchValue` - [out] The size in characters of `ppValue`, or zero if `ppValue` does not hold a string. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + + `ppValue` + [out] A constant string value returned by this member. + + `pcchValue` + [out] The size in characters of `ppValue`, or zero if `ppValue` does not hold a string. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md index dbc29d5ace13a..8c6f56cc0fcf1 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md @@ -2,29 +2,28 @@ description: "Learn more about: IMetaDataImport::GetMemberRefProps Method" title: "IMetaDataImport::GetMemberRefProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetMemberRefProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetMemberRefProps" -helpviewer_keywords: +helpviewer_keywords: - "GetMemberRefProps method [.NET Framework metadata]" - "IMetaDataImport::GetMemberRefProps method [.NET Framework metadata]" -ms.assetid: 0ea73055-ece0-4151-a094-414c88ef8941 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetMemberRefProps Method -Gets metadata associated with the member referenced by the specified token. - -## Syntax - -```cpp -HRESULT GetMemberRefProps ( +Gets metadata associated with the member referenced by the specified token. + +## Syntax + +```cpp +HRESULT GetMemberRefProps ( [in] mdMemberRef mr, [out] mdToken *ptk, [out] LPWSTR szMember, @@ -32,42 +31,42 @@ HRESULT GetMemberRefProps ( [out] ULONG *pchMember, [out] PCCOR_SIGNATURE *ppvSigBlob, [out] ULONG *pbSig -); -``` - -## Parameters - - `mr` - [in] The MemberRef token to return associated metadata for. - - `ptk` - [out] A TypeDef or TypeRef, or TypeSpec token that represents the class that declares the member, or a ModuleRef token that represents the module class that declares the member, or a MethodDef that represents the member. - - `szMember` - [out] A string buffer for the member's name. - - `cchMember` - [in] The requested size in wide characters of `szMember`. - - `pchMember` - [out] The returned size in wide characters of `szMember`. - - `ppvSibBlob` - [out] A pointer to the binary metadata signature for the member. - - `pbSig` - [out] The size in bytes of `ppvSigBlob`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `mr` + [in] The MemberRef token to return associated metadata for. + + `ptk` + [out] A TypeDef or TypeRef, or TypeSpec token that represents the class that declares the member, or a ModuleRef token that represents the module class that declares the member, or a MethodDef that represents the member. + + `szMember` + [out] A string buffer for the member's name. + + `cchMember` + [in] The requested size in wide characters of `szMember`. + + `pchMember` + [out] The returned size in wide characters of `szMember`. + + `ppvSibBlob` + [out] A pointer to the binary metadata signature for the member. + + `pbSig` + [out] The size in bytes of `ppvSigBlob`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md new file mode 100644 index 0000000000000..98cec6269b508 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md @@ -0,0 +1,85 @@ +--- +description: "Learn more about: IMetaDataImport::GetMethodProps Method" +title: "IMetaDataImport::GetMethodProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetMethodProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetMethodProps" +helpviewer_keywords: + - "GetMethodProps method [.NET Framework metadata]" + - "IMetaDataImport::GetMethodProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetMethodProps Method + +Gets the metadata associated with the method referenced by the specified MethodDef token. + +## Syntax + +```cpp +HRESULT GetMethodProps ( + [in] mdMethodDef mb, + [out] mdTypeDef *pClass, + [out] LPWSTR szMethod, + [in] ULONG cchMethod, + [out] ULONG *pchMethod, + [out] DWORD *pdwAttr, + [out] PCCOR_SIGNATURE *ppvSigBlob, + [out] ULONG *pcbSigBlob, + [out] ULONG *pulCodeRVA, + [out] DWORD *pdwImplFlags +); +``` + +## Parameters + + `mb` + [in] The MethodDef token that represents the method to return metadata for. + + `pClass` + [out] A Pointer to a TypeDef token that represents the type that implements the method. + + `szMethod` + [out] A Pointer to a buffer that has the method's name. + + `cchMethod` + [in] The requested size of `szMethod`. + + `pchMethod` + [out] A Pointer to the size in wide characters of `szMethod`, or in the case of truncation, the actual number of wide characters in the method name. + + `pdwAttr` + [out] A pointer to any flags associated with the method. + + `ppvSigBlob` + [out] A pointer to the binary metadata signature of the method. + + `pcbSigBlob` + [out] A Pointer to the size in bytes of `ppvSigBlob`. + + `pulCodeRVA` + [out] A pointer to the relative virtual address of the method. + + `pdwImplFlags` + [out] A pointer to any implementation flags for the method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md index 0e4b80d0dce65..3100c4cc0d3cb 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataImport::GetMethodSemantics Method" title: "IMetaDataImport::GetMethodSemantics Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetMethodSemantics" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetMethodSemantics" -helpviewer_keywords: +helpviewer_keywords: - "GetMethodSemantics method [.NET Framework metadata]" - "IMetaDataImport::GetMethodSemantics method [.NET Framework metadata]" -ms.assetid: 5e018eaa-d60e-4a0b-a2c5-8c36bd09d905 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetMethodSemantics Method -Gets flags indicating the relationship between the method referenced by the specified MethodDef token and the paired property and event referenced by the specified EventProp token. - -## Syntax - -```cpp -HRESULT GetMethodSemantics ( - [in] mdMethodDef mb, - [in] mdToken tkEventProp, - [out] DWORD *pdwSemanticsFlags -); -``` - -## Parameters - - `mb` - [in] A MethodDef token representing the method to get the semantic role information for. - - `tkEventProp` - [in] A token representing the paired property and event for which to get the method's role. - - `pdwSemanticsFlags` - [out] A pointer to the associated semantics flags. This value is a bitmask from the [CorMethodSemanticsAttr](cormethodsemanticsattr-enumeration.md) enumeration. - -## Remarks - - The [IMetaDataEmit::DefineProperty](imetadataemit-defineproperty-method.md) method sets a method's semantics flags. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets flags indicating the relationship between the method referenced by the specified MethodDef token and the paired property and event referenced by the specified EventProp token. + +## Syntax + +```cpp +HRESULT GetMethodSemantics ( + [in] mdMethodDef mb, + [in] mdToken tkEventProp, + [out] DWORD *pdwSemanticsFlags +); +``` + +## Parameters + + `mb` + [in] A MethodDef token representing the method to get the semantic role information for. + + `tkEventProp` + [in] A token representing the paired property and event for which to get the method's role. + + `pdwSemanticsFlags` + [out] A pointer to the associated semantics flags. This value is a bitmask from the [CorMethodSemanticsAttr](cormethodsemanticsattr-enumeration.md) enumeration. + +## Remarks + + The [IMetaDataEmit::DefineProperty](imetadataemit-defineproperty-method.md) method sets a method's semantics flags. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md index 62e6f5efd5204..822a78c59fe25 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataImport::GetModuleFromScope Method" title: "IMetaDataImport::GetModuleFromScope Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetModuleFromScope" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetModuleFromScope" -helpviewer_keywords: +helpviewer_keywords: - "GetModuleFromScope method [.NET Framework metadata]" - "IMetaDataImport::GetModuleFromScope method [.NET Framework metadata]" -ms.assetid: add68d3f-45fd-4bef-af94-eb5273f26b11 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetModuleFromScope Method -Gets a metadata token for the module referenced in the current metadata scope. - -## Syntax - -```cpp -HRESULT GetModuleFromScope ( - [out] mdModule *pmd -); -``` - -## Parameters - - `pmd` - [out] A pointer to the token representing the module referenced in the current metadata scope. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a metadata token for the module referenced in the current metadata scope. + +## Syntax + +```cpp +HRESULT GetModuleFromScope ( + [out] mdModule *pmd +); +``` + +## Parameters + + `pmd` + [out] A pointer to the token representing the module referenced in the current metadata scope. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md index c1ea521e05ec5..051d782260a96 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataImport::GetModuleRefProps Method" title: "IMetaDataImport::GetModuleRefProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetModuleRefProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetModuleRefProps" -helpviewer_keywords: +helpviewer_keywords: - "GetModuleRefProps method [.NET Framework metadata]" - "IMetaDataImport::GetModuleRefProps method [.NET Framework metadata]" -ms.assetid: b558e766-4c11-4628-ae47-b4e0a1800168 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetModuleRefProps Method -Gets the name of the module referenced by the specified metadata token. - -## Syntax - -```cpp -HRESULT GetModuleRefProps ( - [in] mdModuleRef mur, +Gets the name of the module referenced by the specified metadata token. + +## Syntax + +```cpp +HRESULT GetModuleRefProps ( + [in] mdModuleRef mur, [out] LPWSTR szName, [in] ULONG cchName, [out] ULONG *pchName -); -``` - -## Parameters - - `mur` - [in] The ModuleRef metadata token that references the module to get metadata information for. - - `szName` - [out] A buffer to hold the module name. - - `cchName` - [in] The requested size of `szName` in wide characters. - - `pchName` - [out] The returned size of `szName` in wide characters. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `mur` + [in] The ModuleRef metadata token that references the module to get metadata information for. + + `szName` + [out] A buffer to hold the module name. + + `cchName` + [in] The requested size of `szName` in wide characters. + + `pchName` + [out] The returned size of `szName` in wide characters. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md index 1e42ab7bacb52..21f945d2fbc10 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport::GetNameFromToken Method" title: "IMetaDataImport::GetNameFromToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetNameFromToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetNameFromToken" -helpviewer_keywords: +helpviewer_keywords: - "GetNameFromToken method [.NET Framework metadata]" - "IMetaDataImport::GetNameFromToken method [.NET Framework metadata]" -ms.assetid: 32114ecf-8916-4ab2-a201-179c017344f1 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetNameFromToken Method -Gets the UTF-8 name of the object referenced by the specified metadata token. This method is obsolete. - -## Syntax - -```cpp -HRESULT GetNameFromToken ( - [in] mdToken tk, - [out] MDUTF8CSTR *pszUtf8NamePtr -); -``` - -## Parameters - - `tk` - [in] The token representing the object to return the name for. - - `pszUtf8NamePtr` - [out] A pointer to the UTF-8 object name in the heap. - -## Remarks - - `GetNameFromToken` is obsolete. As an alternative, call a method to get the properties of the particular type of token required, such as `GetFieldProps` for a field or `GetMethodProps` for a method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** 1.0 - +Gets the UTF-8 name of the object referenced by the specified metadata token. This method is obsolete. + +## Syntax + +```cpp +HRESULT GetNameFromToken ( + [in] mdToken tk, + [out] MDUTF8CSTR *pszUtf8NamePtr +); +``` + +## Parameters + + `tk` + [in] The token representing the object to return the name for. + + `pszUtf8NamePtr` + [out] A pointer to the UTF-8 object name in the heap. + +## Remarks + + `GetNameFromToken` is obsolete. As an alternative, call a method to get the properties of the particular type of token required, such as `GetFieldProps` for a field or `GetMethodProps` for a method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md new file mode 100644 index 0000000000000..055d8a2f79f52 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: IMetaDataImport::GetNativeCallConvFromSig Method" +title: "IMetaDataImport::GetNativeCallConvFromSig Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetNativeCallConvFromSig" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetNativeCallConvFromSig" +helpviewer_keywords: + - "GetNativeCallConvFromSig method [.NET Framework metadata]" + - "IMetaDataImport::GetNativeCallConvFromSig method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetNativeCallConvFromSig Method + +Gets the native calling convention for the method that is represented by the specified signature pointer. + +## Syntax + +```cpp +HRESULT GetNativeCallConvFromSig ( + [in] void const *pvSig, + [in] ULONG cbSig, + [out] ULONG *pCallConv +); +``` + +## Parameters + + `pvSig` + [in] A pointer to the metadata signature of the method to return the calling convention for. + + `cbSig` + [in] The size in bytes of `pvSig`. + + `pCallConv` + [out] A pointer to the native calling convention. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md index 9b05cd0e99d9d..75a7dd7f3bd7d 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataImport::GetNestedClassProps Method" title: "IMetaDataImport::GetNestedClassProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetNestedClassProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetNestedClassProps" -helpviewer_keywords: +helpviewer_keywords: - "GetNestedClassProps method [.NET Framework metadata]" - "IMetaDataImport::GetNestedClassProps method [.NET Framework metadata]" -ms.assetid: 704d19f1-bdef-4745-af8c-6476eb246fb3 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetNestedClassProps Method -Gets the TypeDef token for the parent of the specified nested type. - -## Syntax - -```cpp -HRESULT GetNestedClassProps ( - [in] mdTypeDef tdNestedClass, - [out] mdTypeDef *ptdEnclosingClass -); -``` - -## Parameters - - `tdNestedClass` - [in] A TypeDef token representing the to return the parent class token for. - - `ptdEnclosingClass` - [out] A pointer to the TypeDef token for the that `tdNestedClass` is nested in. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the TypeDef token for the parent of the specified nested type. + +## Syntax + +```cpp +HRESULT GetNestedClassProps ( + [in] mdTypeDef tdNestedClass, + [out] mdTypeDef *ptdEnclosingClass +); +``` + +## Parameters + + `tdNestedClass` + [in] A TypeDef token representing the to return the parent class token for. + + `ptdEnclosingClass` + [out] A pointer to the TypeDef token for the that `tdNestedClass` is nested in. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md index d54e67f474cf8..f6763087920c8 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport::GetParamForMethodIndex Method" title: "IMetaDataImport::GetParamForMethodIndex Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetParamForMethodIndex" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetParamForMethodIndex" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetParamForMethodIndex method [.NET Framework metadata]" - "GetParamForMethodIndex method [.NET Framework metadata]" -ms.assetid: ec3bfa95-1920-4511-932e-3ff23d76fcb8 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetParamForMethodIndex Method -Gets the token that represents a specified parameter of the method represented by the specified MethodDef token. - -## Syntax - -```cpp -HRESULT GetParamForMethodIndex ( - [in] mdMethodDef md, - [in] ULONG ulParamSeq, - [out] mdParamDef *ppd -); -``` - -## Parameters - - `md` - [in] A token that represents the method to return the parameter token for. - - `ulParamSeq` - [in] The ordinal position in the parameter list where the requested parameter occurs. Parameters are numbered starting from one, with the method's return value in position zero. - - `ppd` - [out] A pointer to a ParamDef token that represents the requested parameter. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the token that represents a specified parameter of the method represented by the specified MethodDef token. + +## Syntax + +```cpp +HRESULT GetParamForMethodIndex ( + [in] mdMethodDef md, + [in] ULONG ulParamSeq, + [out] mdParamDef *ppd +); +``` + +## Parameters + + `md` + [in] A token that represents the method to return the parameter token for. + + `ulParamSeq` + [in] The ordinal position in the parameter list where the requested parameter occurs. Parameters are numbered starting from one, with the method's return value in position zero. + + `ppd` + [out] A pointer to a ParamDef token that represents the requested parameter. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md new file mode 100644 index 0000000000000..14ed322e0dea0 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md @@ -0,0 +1,89 @@ +--- +description: "Learn more about: IMetaDataImport::GetParamProps Method" +title: "IMetaDataImport::GetParamProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetParamProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetParamProps" +helpviewer_keywords: + - "IMetaDataImport::GetParamProps method [.NET Framework metadata]" + - "GetParamProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetParamProps Method + +Gets metadata values for the parameter referenced by the specified ParamDef token. + +## Syntax + +```cpp +HRESULT GetParamProps ( + [in] mdParamDef tk, + [out] mdMethodDef *pmd, + [out] ULONG *pulSequence, + [out] LPWSTR szName, + [in] ULONG cchName, + [out] ULONG *pchName, + [out] DWORD *pdwAttr, + [out] DWORD *pdwCPlusTypeFlag, + [out] UVCP_CONSTANT *ppValue, + [out] ULONG *pcchValue +); +``` + +## Parameters + + `tk` + [in] A ParamDef token that represents the parameter to return metadata for. + + `pmd` + [out] A pointer to a MethodDef token representing the method that takes the parameter. + + `pulSequence` + [out] The ordinal position of the parameter in the method argument list. + + `szName` + [out] A buffer to hold the name of the parameter. + + `cchName` + [in] The requested size in wide characters of `szName`. + + `pchName` + [out] The returned size in wide characters of `szName`. + + `pdwAttr` + [out] A pointer to any attribute flags associated with the parameter. This is a bitmask of `CorParamAttr` values. + + `pdwCPlusTypeFlag` + [out] A pointer to a flag specifying that the parameter is a . + + `ppValue` + [out] A pointer to a constant string returned by the parameter. + + `pcchValue` + [out] The size of `ppValue` in wide characters, or zero if `ppValue` does not hold a string. + +## Remarks + +The sequence values in `pulSequence` begin with 1 for parameters. A return value has a sequence number of 0. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md index 5bf7288d0973f..7963343b9d357 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataImport::GetPermissionSetProps Method" title: "IMetaDataImport::GetPermissionSetProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetPermissionSetProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetPermissionSetProps" -helpviewer_keywords: +helpviewer_keywords: - "GetPermissionSetProps method [.NET Framework metadata]" - "IMetaDataImport::GetPermissionSetProps method [.NET Framework metadata]" -ms.assetid: 9855f0e4-12c0-4d3d-ab5d-d6bc52d25eae -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetPermissionSetProps Method -Gets the metadata associated with the represented by the specified Permission token. - -## Syntax - -```cpp -HRESULT GetPermissionSetProps ( - [in] mdPermission pm, +Gets the metadata associated with the represented by the specified Permission token. + +## Syntax + +```cpp +HRESULT GetPermissionSetProps ( + [in] mdPermission pm, [out] DWORD *pdwAction, [out] void const **ppvPermission, - [out] ULONG *pcbPermission -); -``` - -## Parameters - - `pm` - [in] The Permission metadata token that represents the permission set to get the metadata properties for. - - `pdwAction` - [out] A pointer to the permission set. - - `ppvPermission` - [out] A pointer to the binary metadata signature of the permission set. - - `pcbPermission` - [out] The size in bytes of `ppvPermission`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] ULONG *pcbPermission +); +``` + +## Parameters + + `pm` + [in] The Permission metadata token that represents the permission set to get the metadata properties for. + + `pdwAction` + [out] A pointer to the permission set. + + `ppvPermission` + [out] A pointer to the binary metadata signature of the permission set. + + `pcbPermission` + [out] The size in bytes of `ppvPermission`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md new file mode 100644 index 0000000000000..cd44e887bb85f --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md @@ -0,0 +1,69 @@ +--- +description: "Learn more about: IMetaDataImport::GetPinvokeMap Method" +title: "IMetaDataImport::GetPinvokeMap Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetPinvokeMap" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetPinvokeMap" +helpviewer_keywords: + - "IMetaDataImport::GetPinvokeMap method [.NET Framework metadata]" + - "GetPinvokeMap method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetPinvokeMap Method + +Gets a ModuleRef token to represent the target assembly of a PInvoke call. + +## Syntax + +```cpp +HRESULT GetPinvokeMap ( + [in] mdToken tk, + [out] DWORD *pdwMappingFlags, + [out] LPWSTR szImportName, + [in] ULONG cchImportName, + [out] ULONG *pchImportName, + [out] mdModuleRef *pmrImportDLL +); +``` + +## Parameters + + `tk` + [in] A FieldDef or MethodDef token to get the PInvoke mapping metadata for. + + `pdwMappingFlags` + [out] A pointer to flags used for mapping. This value is a bitmask from the [CorPinvokeMap](corpinvokemap-enumeration.md) enumeration. + + `szImportName` + [out] The name of the unmanaged target DLL. + + `cchImportName` + [in] The size in wide characters of `szImportName`. + + `pchImportName` + [out] The number of wide characters returned in `szImportName`. + + `pmrImportDLL` + [out] A pointer to a ModuleRef token that represents the unmanaged target object library. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md similarity index 57% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md index 1193da5b0e247..71140bb1d1ac9 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md @@ -2,30 +2,29 @@ description: "Learn more about: IMetaDataImport::GetPropertyProps Method" title: "IMetaDataImport::GetPropertyProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetPropertyProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetPropertyProps" -helpviewer_keywords: +helpviewer_keywords: - "GetPropertyProps method [.NET Framework metadata]" - "IMetaDataImport::GetPropertyProps method [.NET Framework metadata]" -ms.assetid: dc0ff3e6-7e7d-4f6c-948d-52b28f5cb78c -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetPropertyProps Method -Gets the metadata for the property represented by the specified token. - -## Syntax - -```cpp -HRESULT GetPropertyProps ( - [in] mdProperty prop, +Gets the metadata for the property represented by the specified token. + +## Syntax + +```cpp +HRESULT GetPropertyProps ( + [in] mdProperty prop, [out] mdTypeDef *pClass, [out] LPCWSTR szProperty, [in] ULONG cchProperty, @@ -34,76 +33,76 @@ HRESULT GetPropertyProps ( [out] PCCOR_SIGNATURE *ppvSig, [out] ULONG *pbSig, [out] DWORD *pdwCPlusTypeFlag, - [out] UVCP_CONSTANT *ppDefaultValue, - [out] ULONG *pcchDefaultValue, + [out] UVCP_CONSTANT *ppDefaultValue, + [out] ULONG *pcchDefaultValue, [out] mdMethodDef *pmdSetter, [out] mdMethodDef *pmdGetter, - [out] mdMethodDef rmdOtherMethod[], + [out] mdMethodDef rmdOtherMethod[], [in] ULONG cMax, [out] ULONG *pcOtherMethod -); -``` - -## Parameters - - `prop` - [in] A token that represents the property to return metadata for. - - `pClass` - [out] A pointer to the TypeDef token that represents the type that implements the property. - - `szProperty` - [out] A buffer to hold the property name. - - `cchProperty` - [in] The size in wide characters of `szProperty`. - - `pchProperty` - [out] The number of wide characters returned in `szProperty`. - - `pdwPropFlags` - [out] A pointer to any attribute flags applied to the property. This value is a bitmask from the [CorPropertyAttr](corpropertyattr-enumeration.md) enumeration. - - `ppvSig` - [out] A pointer to the metadata signature of the property. - - `pbSig` - [out] The number of bytes returned in `ppvSig`. - - `pdwCPlusTypeFlag` - [out] A flag specifying the type of the constant that is the default value of the property. This value is from the CorElementType enumeration. - - `ppDefaultValue` - [out] A pointer to the bytes that store the default value for this property. - - `pcchDefaultValue` - [out] The size in wide characters of `ppDefaultValue`, if `pdwCPlusTypeFlag` is ELEMENT_TYPE_STRING; otherwise, this value is not relevant. In that case, the length of `ppDefaultValue` is inferred from the type that is specified by `pdwCPlusTypeFlag`. - - `pmdSetter` - [out] A pointer to the MethodDef token that represents the set accessor method for the property. - - `pmdGetter` - [out] A pointer to the MethodDef token that represents the get accessor method for the property. - - `rmdOtherMethod` - [out] An array of MethodDef tokens that represent other methods associated with the property. - - `cMax` - [in] The maximum size of the `rmdOtherMethod` array. If you do not provide an array large enough to hold all the methods, they are skipped without warning. - - `pcOtherMethod` - [out] The number of MethodDef tokens returned in `rmdOtherMethod`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `prop` + [in] A token that represents the property to return metadata for. + + `pClass` + [out] A pointer to the TypeDef token that represents the type that implements the property. + + `szProperty` + [out] A buffer to hold the property name. + + `cchProperty` + [in] The size in wide characters of `szProperty`. + + `pchProperty` + [out] The number of wide characters returned in `szProperty`. + + `pdwPropFlags` + [out] A pointer to any attribute flags applied to the property. This value is a bitmask from the [CorPropertyAttr](corpropertyattr-enumeration.md) enumeration. + + `ppvSig` + [out] A pointer to the metadata signature of the property. + + `pbSig` + [out] The number of bytes returned in `ppvSig`. + + `pdwCPlusTypeFlag` + [out] A flag specifying the type of the constant that is the default value of the property. This value is from the CorElementType enumeration. + + `ppDefaultValue` + [out] A pointer to the bytes that store the default value for this property. + + `pcchDefaultValue` + [out] The size in wide characters of `ppDefaultValue`, if `pdwCPlusTypeFlag` is ELEMENT_TYPE_STRING; otherwise, this value is not relevant. In that case, the length of `ppDefaultValue` is inferred from the type that is specified by `pdwCPlusTypeFlag`. + + `pmdSetter` + [out] A pointer to the MethodDef token that represents the set accessor method for the property. + + `pmdGetter` + [out] A pointer to the MethodDef token that represents the get accessor method for the property. + + `rmdOtherMethod` + [out] An array of MethodDef tokens that represent other methods associated with the property. + + `cMax` + [in] The maximum size of the `rmdOtherMethod` array. If you do not provide an array large enough to hold all the methods, they are skipped without warning. + + `pcOtherMethod` + [out] The number of MethodDef tokens returned in `rmdOtherMethod`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getrva-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md similarity index 56% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getrva-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md index db9bf020af5ef..283ff9693e1a2 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport::GetRVA Method" title: "IMetaDataImport::GetRVA Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetRVA" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetRVA" -helpviewer_keywords: +helpviewer_keywords: - "GetRVA method [.NET Framework metadata]" - "IMetaDataImport::GetRVA method [.NET Framework metadata]" -ms.assetid: ea422217-988b-4acd-b2db-c55357938275 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetRVA Method -Gets the relative virtual address (RVA) and the implementation flags of the method or field represented by the specified token. - -## Syntax - -```cpp -HRESULT GetRVA ( +Gets the relative virtual address (RVA) and the implementation flags of the method or field represented by the specified token. + +## Syntax + +```cpp +HRESULT GetRVA ( [in] mdToken tk, [out] ULONG *pulCodeRVA, - [out] DWORD *pdwImplFlags -); -``` - -## Parameters - - `tk` - [in] A MethodDef or FieldDef metadata token that represents the code object to return the RVA for. If the token is a FieldDef, the field must be a global variable. - - `pulCodeRVA` - [out] A pointer to the relative virtual address of the code object represented by the token. - - `pdwImplFlags` - [out] A pointer to the implementation flags for the method. This value is a bitmask from the [CorMethodImpl](cormethodimpl-enumeration.md) enumeration. The value of `pdwImplFlags` is valid only if `tk` is a MethodDef token. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] DWORD *pdwImplFlags +); +``` + +## Parameters + + `tk` + [in] A MethodDef or FieldDef metadata token that represents the code object to return the RVA for. If the token is a FieldDef, the field must be a global variable. + + `pulCodeRVA` + [out] A pointer to the relative virtual address of the code object represented by the token. + + `pdwImplFlags` + [out] A pointer to the implementation flags for the method. This value is a bitmask from the [CorMethodImpl](cormethodimpl-enumeration.md) enumeration. The value of `pdwImplFlags` is valid only if `tk` is a MethodDef token. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md new file mode 100644 index 0000000000000..b969b86d76ce1 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md @@ -0,0 +1,65 @@ +--- +description: "Learn more about: IMetaDataImport::GetScopeProps Method" +title: "IMetaDataImport::GetScopeProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetScopeProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetScopeProps" +helpviewer_keywords: + - "IMetaDataImport::GetScopeProps method [.NET Framework metadata]" + - "GetScopeProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetScopeProps Method + +Gets the name and optionally the version identifier of the assembly or module in the current metadata scope. + +## Syntax + +```cpp +HRESULT GetScopeProps ( + [out] LPWSTR szName, + [in] ULONG cchName, + [out] ULONG *pchName, + [out, optional] GUID *pmvid +); +``` + +## Parameters + + `szName` + [out] A buffer for the assembly or module name. + + `cchName` + [in] The size in wide characters of `szName`. + + `pchName` + [out] The number of wide characters returned in `szName`. + + `pmvid` + [out, optional] A pointer to a GUID that uniquely identifies the version of the assembly or module. + +## Remarks + + The [IMetaDataEmit::SetModuleProps](imetadataemit-setmoduleprops-method.md) method is used to set these properties. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md index 726d628e73de6..0a391463160fa 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport::GetSigFromToken Method" title: "IMetaDataImport::GetSigFromToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetSigFromToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetSigFromToken" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetSigFromToken method [.NET Framework metadata]" - "GetSigFromToken method [.NET Framework metadata]" -ms.assetid: ab894dc4-f7b6-4afc-bfcb-582a4b7e53a2 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetSigFromToken Method -Gets the binary metadata signature associated with the specified token. - -## Syntax - -```cpp +Gets the binary metadata signature associated with the specified token. + +## Syntax + +```cpp HRESULT GetSigFromToken ( [in] mdSignature mdSig, [out] PCCOR_SIGNATURE *ppvSig, [out] ULONG *pcbSig -); -``` - -## Parameters - - `mdSig` - [in] The token to return the binary metadata signature for. - - `ppvSig` - [out] A pointer to the returned metadata signature. - - `pcbSig` - [out] The size in bytes of the binary metadata signature. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## Parameters + + `mdSig` + [in] The token to return the binary metadata signature for. + + `ppvSig` + [out] A pointer to the returned metadata signature. + + `pcbSig` + [out] The size in bytes of the binary metadata signature. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md new file mode 100644 index 0000000000000..ef09d9e0990d4 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md @@ -0,0 +1,69 @@ +--- +description: "Learn more about: IMetaDataImport::GetTypeDefProps Method" +title: "IMetaDataImport::GetTypeDefProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetTypeDefProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetTypeDefProps" +helpviewer_keywords: + - "GetTypeDefProps method [.NET Framework metadata]" + - "IMetaDataImport::GetTypeDefProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetTypeDefProps Method + +Returns metadata information for the represented by the specified TypeDef token. + +## Syntax + +```cpp +HRESULT GetTypeDefProps ( + [in] mdTypeDef td, + [out] LPWSTR szTypeDef, + [in] ULONG cchTypeDef, + [out] ULONG *pchTypeDef, + [out] DWORD *pdwTypeDefFlags, + [out] mdToken *ptkExtends +); +``` + +## Parameters + + `td` + [in] The TypeDef token that represents the type to return metadata for. + + `szTypeDef` + [out] A buffer containing the type name. + + `cchTypeDef` + [in] The size in wide characters of `szTypeDef`. + + `pchTypeDef` + [out] The number of wide characters returned in `szTypeDef`. + + `pdwTypeDefFlags` + [out] A pointer to any flags that modify the type definition. This value is a bitmask from the [CorTypeAttr](cortypeattr-enumeration.md) enumeration. + + `ptkExtends` + [out] A TypeDef or TypeRef metadata token that represents the base type of the requested type. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md new file mode 100644 index 0000000000000..153b5a7129e31 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md @@ -0,0 +1,65 @@ +--- +description: "Learn more about: IMetaDataImport::GetTypeRefProps Method" +title: "IMetaDataImport::GetTypeRefProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetTypeRefProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetTypeRefProps" +helpviewer_keywords: + - "IMetaDataImport::GetTypeRefProps method [.NET Framework metadata]" + - "GetTypeRefProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetTypeRefProps Method + +Gets the metadata associated with the referenced by the specified TypeRef token. + +## Syntax + +```cpp +HRESULT GetTypeRefProps ( + [in] mdTypeRef tr, + [out] mdToken *ptkResolutionScope, + [out] LPWSTR szName, + [in] ULONG cchName, + [out] ULONG *pchName +); +``` + +## Parameters + + `tr` + [in] The TypeRef token that represents the type to return metadata for. + + `ptkResolutionScope` + [out] A pointer to the scope in which the reference is made. This value is an AssemblyRef or ModuleRef token. + + `szName` + [out] A buffer containing the type name. + + `cchName` + [in] The requested size in wide characters of `szName`. + + `pchName` + [out] The returned size in wide characters of `szName`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md index 01753d12ee8bb..a73a923730975 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataImport::GetTypeSpecFromToken Method" title: "IMetaDataImport::GetTypeSpecFromToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetTypeSpecFromToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetTypeSpecFromToken" -helpviewer_keywords: +helpviewer_keywords: - "GetTypeSpecFromToken method [.NET Framework metadata]" - "IMetaDataImport::GetTypeSpecFromToken method [.NET Framework metadata]" -ms.assetid: ee518bda-3296-482e-a7b7-e9d51dd1a181 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetTypeSpecFromToken Method -Gets the binary metadata signature of the type specification represented by the specified token. - -## Syntax - -```cpp +Gets the binary metadata signature of the type specification represented by the specified token. + +## Syntax + +```cpp HRESULT GetTypeSpecFromToken ( [in] mdTypeSpec typespec, [out] PCCOR_SIGNATURE *ppvSig, - [out] ULONG *pcbSig -); -``` - -## Parameters - - `typespec` - [in] The TypeSpec token associated with the requested metadata signature. - - `ppvSig` - [out] A pointer to the binary metadata signature. - - `pcbSig` - [out] The size, in bytes, of the metadata signature. - -## Return Value - - An HRESULT that indicates success or failure. Failures can be tested with the FAILED macro. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] ULONG *pcbSig +); +``` + +## Parameters + + `typespec` + [in] The TypeSpec token associated with the requested metadata signature. + + `ppvSig` + [out] A pointer to the binary metadata signature. + + `pcbSig` + [out] The size, in bytes, of the metadata signature. + +## Return Value + + An HRESULT that indicates success or failure. Failures can be tested with the FAILED macro. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md new file mode 100644 index 0000000000000..dd3458aaf94a6 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md @@ -0,0 +1,61 @@ +--- +description: "Learn more about: IMetaDataImport::GetUserString Method" +title: "IMetaDataImport::GetUserString Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.GetUserString" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::GetUserString" +helpviewer_keywords: + - "IMetaDataImport::GetUserString method [.NET Framework metadata]" + - "GetUserString method, IMetaDataImport interface [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::GetUserString Method + +Gets the literal string represented by the specified metadata token. + +## Syntax + +```cpp +HRESULT GetUserString ( + [in] mdString stk, + [out] LPWSTR szString, + [in] ULONG cchString, + [out] ULONG *pchString +); +``` + +## Parameters + + `stk` + [in] The String token to return the associated string for. + + `szString` + [out] A copy of the requested string. + + `cchString` + [in] The maximum size in wide characters of the requested `szString`. + + `pchString` + [out] The size in wide characters of the returned `szString`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md similarity index 78% rename from docs/framework/unmanaged-api/metadata/imetadataimport-interface.md rename to docs/core/unmanaged-api/metadata/imetadataimport-interface.md index 351dd7b30384f..eea88e29a8646 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md @@ -2,113 +2,112 @@ description: "Learn more about: IMetaDataImport Interface" title: "IMetaDataImport Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport interface [.NET Framework metadata]" -ms.assetid: 0adbbd35-5e8d-4fec-8268-dc70a07c5975 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport Interface -Provides methods for importing and manipulating existing metadata from a portable executable (PE) file or other source, such as a type library or a stand-alone, run-time metadata binary. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CloseEnum Method](imetadataimport-closeenum-method.md)|Closes the enumerator with the specified handle.| -|[CountEnum Method](imetadataimport-countenum-method.md)|Gets the number of elements in the enumerator with the specified handle.| -|[EnumCustomAttributes Method](imetadataimport-enumcustomattributes-method.md)|Enumerates a list of custom attribute-definition tokens associated with the specified type or member.| -|[EnumEvents Method](imetadataimport-enumevents-method.md)|Enumerates event definition tokens for the specified TypeDef token.| -|[EnumFields Method](imetadataimport-enumfields-method.md)|Enumerates FieldDef tokens for the type referenced by the specified TypeDef token.| -|[EnumFieldsWithName Method](imetadataimport-enumfieldswithname-method.md)|Enumerates FieldDef tokens of the specified type with the specified name.| -|[EnumInterfaceImpls Method](imetadataimport-enuminterfaceimpls-method.md)|Enumerates MethodDef tokens representing interface implementations.| -|[EnumMemberRefs Method](imetadataimport-enummemberrefs-method.md)|Enumerates MemberRef tokens representing members of the specified type.| -|[EnumMembers Method](imetadataimport-enummembers-method.md)|Enumerates MemberDef tokens representing members of the specified type.| -|[EnumMembersWithName Method](imetadataimport-enummemberswithname-method.md)|Enumerates MemberDef tokens representing members of the specified type with the specified name.| -|[EnumMethodImpls Method](imetadataimport-enummethodimpls-method.md)|Enumerates MethodBody and MethodDeclaration tokens representing methods of the specified type.| -|[EnumMethods Method](imetadataimport-enummethods-method.md)|Enumerates MethodDef tokens representing methods of the specified type.| -|[EnumMethodSemantics Method](imetadataimport-enummethodsemantics-method.md)|Enumerates the properties and the property-change events to which the specified method is related.| -|[EnumMethodsWithName Method](imetadataimport-enummethodswithname-method.md)|Enumerates methods that have the specified name and that are defined by the type referenced by the specified TypeDef token.| -|[EnumModuleRefs Method](imetadataimport-enummodulerefs-method.md)|Enumerates ModuleRef tokens that represent imported modules.| -|[EnumParams Method](imetadataimport-enumparams-method.md)|Enumerates ParamDef tokens representing the parameters of the method referenced by the specified MethodDef token.| -|[EnumPermissionSets Method](imetadataimport-enumpermissionsets-method.md)|Enumerates permissions for the objects in a specified metadata scope.| -|[EnumProperties Method](imetadataimport-enumproperties-method.md)|Enumerates PropertyDef tokens representing the properties of the type referenced by the specified TypeDef token.| -|[EnumSignatures Method](imetadataimport-enumsignatures-method.md)|Enumerates Signature tokens representing stand-alone signatures in the current scope.| -|[EnumTypeDefs Method](imetadataimport-enumtypedefs-method.md)|Enumerates TypeDef tokens representing all types within the current scope.| -|[EnumTypeRefs Method](imetadataimport-enumtyperefs-method.md)|Enumerates TypeRef tokens defined in the current metadata scope.| -|[EnumTypeSpecs Method](imetadataimport-enumtypespecs-method.md)|Enumerates TypeSpec tokens defined in the current metadata scope.| -|[EnumUnresolvedMethods Method](imetadataimport-enumunresolvedmethods-method.md)|Enumerates MemberDef tokens representing the unresolved methods in the current metadata scope.| -|[EnumUserStrings Method](imetadataimport-enumuserstrings-method.md)|Enumerates String tokens representing hard-coded strings in the current metadata scope.| -|[FindField Method](imetadataimport-findfield-method.md)|Gets the FieldDef token for the field that is a member of the specified type, and has the specified name and metadata signature.| -|[FindMember Method](imetadataimport-findmember-method.md)|Gets a pointer to the MemberDef token for the member defined by the specified type with the specified name and metadata signature.| -|[FindMemberRef Method](imetadataimport-findmemberref-method.md)|Gets a pointer to the MemberRef token for the member defined by the specified type with the specified name and metadata signature.| -|[FindMethod Method](imetadataimport-findmethod-method.md)|Gets a pointer to the MethodDef token for the method defined by the specified type with the specified name and metadata signature.| -|[FindTypeDefByName Method](imetadataimport-findtypedefbyname-method.md)|Gets a pointer to the TypeDef metadata token for the type with the specified name.| -|[FindTypeRef Method](imetadataimport-findtyperef-method.md)|Gets a pointer to the TypeRef metadata token that references the type in the specified search scope with the specified name.| -|[GetClassLayout Method](imetadataimport-getclasslayout-method.md)|Gets layout information for the class referenced by the specified TypeDef token.| -|[GetCustomAttributeByName Method](imetadataimport-getcustomattributebyname-method.md)|Gets the value of the custom attribute, given its name.| -|[GetCustomAttributeProps Method](imetadataimport-getcustomattributeprops-method.md)|Gets the value of the custom attribute, given its metadata token.| -|[GetEventProps Method](imetadataimport-geteventprops-method.md)|Gets metadata information (including the declaring type, the add and remove methods for delegates, and any flags and other associated data) for the event represented by the specified event token.| -|[GetFieldMarshal Method](imetadataimport-getfieldmarshal-method.md)|Gets a pointer to the native, unmanaged type of the field represented by the specified Field metadata token.| -|[GetFieldProps Method](imetadataimport-getfieldprops-method.md)|Gets metadata associated with the field referenced by the specified FieldDef token.| -|[GetInterfaceImplProps Method](imetadataimport-getinterfaceimplprops-method.md)|Gets a pointer to the metadata tokens for the type that implements the specified method and for the interface that declares that method.| -|[GetMemberProps Method](imetadataimport-getmemberprops-method.md)|Gets metadata information (including the name, binary signature, and relative virtual address) of the type member referenced by the specified metadata token.| -|[GetMemberRefProps Method](imetadataimport-getmemberrefprops-method.md)|Gets metadata associated with the member referenced by the specified token.| -|[GetMethodProps Method](imetadataimport-getmethodprops-method.md)|Gets the metadata associated with the method referenced by the specified MethodDef token.| -|[GetMethodSemantics Method](imetadataimport-getmethodsemantics-method.md)|Gets a pointer to the relationship between the method referenced by the specified MethodDef token and the paired property and event referenced by the specified EventProp token.| -|[GetModuleFromScope Method](imetadataimport-getmodulefromscope-method.md)|Gets a pointer to the metadata token for the module referenced in the current metadata scope.| -|[GetModuleRefProps Method](imetadataimport-getmodulerefprops-method.md)|Gets the name of the module referenced by the specified metadata token.| -|[GetNameFromToken Method](imetadataimport-getnamefromtoken-method.md)|Gets the UTF-8 name of the object referenced by the specified metadata token.| -|[GetNativeCallConvFromSig Method](imetadataimport-getnativecallconvfromsig-method.md)|Gets the native calling convention for the method that is represented by the specified signature pointer.| -|[GetNestedClassProps Method](imetadataimport-getnestedclassprops-method.md)|Gets the TypeDef token for the enclosing parent type of the specified nested type.| -|[GetParamForMethodIndex Method](imetadataimport-getparamformethodindex-method.md)|Gets a pointer to the token that represents the parameter at the specified ordinal position in the sequence of method parameters for the method represented by the specified MethodDef token.| -|[GetParamProps Method](imetadataimport-getparamprops-method.md)|Gets metadata values for the parameter referenced by the specified ParamDef token.| -|[GetPermissionSetProps Method](imetadataimport-getpermissionsetprops-method.md)|Gets the metadata associated with the System.Security.PermissionSet represented by the specified Permission token.| -|[GetPinvokeMap](imetadataimport-getpinvokemap-method.md)|Gets a ModuleRef token to represent the target assembly of a PInvoke call.| -|[GetPropertyProps Method](imetadataimport-getpropertyprops-method.md)|Gets the metadata associated with the property represented by the specified token.| -|[GetRVA Method](imetadataimport-getrva-method.md)|Gets the offset of the relative virtual address of the code object represented by the specified token.| -|[GetScopeProps Method](imetadataimport-getscopeprops-method.md)|Gets the name and optionally the version identifier of the assembly or module in the current metadata scope.| -|[GetSigFromToken Method](imetadataimport-getsigfromtoken-method.md)|Gets the binary metadata signature associated with the specified token.| -|[GetTypeDefProps Method](imetadataimport-gettypedefprops-method.md)|Returns metadata information for the type represented by the specified TypeDef token.| -|[GetTypeRefProps Method](imetadataimport-gettyperefprops-method.md)|Gets the metadata associated with the type referenced by the specified TypeRef token.| -|[GetTypeSpecFromToken Method](imetadataimport-gettypespecfromtoken-method.md)|Gets the binary metadata signature of the type specification represented by the specified token.| -|[GetUserString Method](imetadataimport-getuserstring-method.md)|Gets the literal string represented by the specified metadata token.| -|[IsGlobal Method](imetadataimport-isglobal-method.md)|Gets a value indicating whether the field, method, or type represented by the specified metadata token has global scope.| -|[IsValidToken Method](imetadataimport-isvalidtoken-method.md)|Gets a value indicating whether the specified token holds a valid reference to a code object.| -|[ResetEnum Method](imetadataimport-resetenum-method.md)|Resets the specified enumerator to the specified position.| -|[ResolveTypeRef Method](imetadataimport-resolvetyperef-method.md)|Gets type information for the type referenced by the specified TypeRef token.| - -## Remarks - - The design of the `IMetaDataImport` interface is intended primarily to be used by tools and services that will be importing type information (for example, development tools) or managing deployed components (for example, resolution/activation services). The methods in `IMetaDataImport` fall into the following task categories: - -- Enumerating collections of items in the metadata scope. - -- Finding an item that has a specific set of characteristics. - -- Getting properties of a specified item. - -- The Get methods are specifically designed to return single-valued properties of a metadata item. When the property is a reference to another item, a token for that item is returned. Any pointer input type can be NULL to indicate that the particular value is not being requested. To obtain properties that are essentially collection objects (for example, the collection of interfaces that a class implements), use the enumeration methods. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides methods for importing and manipulating existing metadata from a portable executable (PE) file or other source, such as a type library or a stand-alone, run-time metadata binary. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CloseEnum Method](imetadataimport-closeenum-method.md)|Closes the enumerator with the specified handle.| +|[CountEnum Method](imetadataimport-countenum-method.md)|Gets the number of elements in the enumerator with the specified handle.| +|[EnumCustomAttributes Method](imetadataimport-enumcustomattributes-method.md)|Enumerates a list of custom attribute-definition tokens associated with the specified type or member.| +|[EnumEvents Method](imetadataimport-enumevents-method.md)|Enumerates event definition tokens for the specified TypeDef token.| +|[EnumFields Method](imetadataimport-enumfields-method.md)|Enumerates FieldDef tokens for the type referenced by the specified TypeDef token.| +|[EnumFieldsWithName Method](imetadataimport-enumfieldswithname-method.md)|Enumerates FieldDef tokens of the specified type with the specified name.| +|[EnumInterfaceImpls Method](imetadataimport-enuminterfaceimpls-method.md)|Enumerates MethodDef tokens representing interface implementations.| +|[EnumMemberRefs Method](imetadataimport-enummemberrefs-method.md)|Enumerates MemberRef tokens representing members of the specified type.| +|[EnumMembers Method](imetadataimport-enummembers-method.md)|Enumerates MemberDef tokens representing members of the specified type.| +|[EnumMembersWithName Method](imetadataimport-enummemberswithname-method.md)|Enumerates MemberDef tokens representing members of the specified type with the specified name.| +|[EnumMethodImpls Method](imetadataimport-enummethodimpls-method.md)|Enumerates MethodBody and MethodDeclaration tokens representing methods of the specified type.| +|[EnumMethods Method](imetadataimport-enummethods-method.md)|Enumerates MethodDef tokens representing methods of the specified type.| +|[EnumMethodSemantics Method](imetadataimport-enummethodsemantics-method.md)|Enumerates the properties and the property-change events to which the specified method is related.| +|[EnumMethodsWithName Method](imetadataimport-enummethodswithname-method.md)|Enumerates methods that have the specified name and that are defined by the type referenced by the specified TypeDef token.| +|[EnumModuleRefs Method](imetadataimport-enummodulerefs-method.md)|Enumerates ModuleRef tokens that represent imported modules.| +|[EnumParams Method](imetadataimport-enumparams-method.md)|Enumerates ParamDef tokens representing the parameters of the method referenced by the specified MethodDef token.| +|[EnumPermissionSets Method](imetadataimport-enumpermissionsets-method.md)|Enumerates permissions for the objects in a specified metadata scope.| +|[EnumProperties Method](imetadataimport-enumproperties-method.md)|Enumerates PropertyDef tokens representing the properties of the type referenced by the specified TypeDef token.| +|[EnumSignatures Method](imetadataimport-enumsignatures-method.md)|Enumerates Signature tokens representing stand-alone signatures in the current scope.| +|[EnumTypeDefs Method](imetadataimport-enumtypedefs-method.md)|Enumerates TypeDef tokens representing all types within the current scope.| +|[EnumTypeRefs Method](imetadataimport-enumtyperefs-method.md)|Enumerates TypeRef tokens defined in the current metadata scope.| +|[EnumTypeSpecs Method](imetadataimport-enumtypespecs-method.md)|Enumerates TypeSpec tokens defined in the current metadata scope.| +|[EnumUnresolvedMethods Method](imetadataimport-enumunresolvedmethods-method.md)|Enumerates MemberDef tokens representing the unresolved methods in the current metadata scope.| +|[EnumUserStrings Method](imetadataimport-enumuserstrings-method.md)|Enumerates String tokens representing hard-coded strings in the current metadata scope.| +|[FindField Method](imetadataimport-findfield-method.md)|Gets the FieldDef token for the field that is a member of the specified type, and has the specified name and metadata signature.| +|[FindMember Method](imetadataimport-findmember-method.md)|Gets a pointer to the MemberDef token for the member defined by the specified type with the specified name and metadata signature.| +|[FindMemberRef Method](imetadataimport-findmemberref-method.md)|Gets a pointer to the MemberRef token for the member defined by the specified type with the specified name and metadata signature.| +|[FindMethod Method](imetadataimport-findmethod-method.md)|Gets a pointer to the MethodDef token for the method defined by the specified type with the specified name and metadata signature.| +|[FindTypeDefByName Method](imetadataimport-findtypedefbyname-method.md)|Gets a pointer to the TypeDef metadata token for the type with the specified name.| +|[FindTypeRef Method](imetadataimport-findtyperef-method.md)|Gets a pointer to the TypeRef metadata token that references the type in the specified search scope with the specified name.| +|[GetClassLayout Method](imetadataimport-getclasslayout-method.md)|Gets layout information for the class referenced by the specified TypeDef token.| +|[GetCustomAttributeByName Method](imetadataimport-getcustomattributebyname-method.md)|Gets the value of the custom attribute, given its name.| +|[GetCustomAttributeProps Method](imetadataimport-getcustomattributeprops-method.md)|Gets the value of the custom attribute, given its metadata token.| +|[GetEventProps Method](imetadataimport-geteventprops-method.md)|Gets metadata information (including the declaring type, the add and remove methods for delegates, and any flags and other associated data) for the event represented by the specified event token.| +|[GetFieldMarshal Method](imetadataimport-getfieldmarshal-method.md)|Gets a pointer to the native, unmanaged type of the field represented by the specified Field metadata token.| +|[GetFieldProps Method](imetadataimport-getfieldprops-method.md)|Gets metadata associated with the field referenced by the specified FieldDef token.| +|[GetInterfaceImplProps Method](imetadataimport-getinterfaceimplprops-method.md)|Gets a pointer to the metadata tokens for the type that implements the specified method and for the interface that declares that method.| +|[GetMemberProps Method](imetadataimport-getmemberprops-method.md)|Gets metadata information (including the name, binary signature, and relative virtual address) of the type member referenced by the specified metadata token.| +|[GetMemberRefProps Method](imetadataimport-getmemberrefprops-method.md)|Gets metadata associated with the member referenced by the specified token.| +|[GetMethodProps Method](imetadataimport-getmethodprops-method.md)|Gets the metadata associated with the method referenced by the specified MethodDef token.| +|[GetMethodSemantics Method](imetadataimport-getmethodsemantics-method.md)|Gets a pointer to the relationship between the method referenced by the specified MethodDef token and the paired property and event referenced by the specified EventProp token.| +|[GetModuleFromScope Method](imetadataimport-getmodulefromscope-method.md)|Gets a pointer to the metadata token for the module referenced in the current metadata scope.| +|[GetModuleRefProps Method](imetadataimport-getmodulerefprops-method.md)|Gets the name of the module referenced by the specified metadata token.| +|[GetNameFromToken Method](imetadataimport-getnamefromtoken-method.md)|Gets the UTF-8 name of the object referenced by the specified metadata token.| +|[GetNativeCallConvFromSig Method](imetadataimport-getnativecallconvfromsig-method.md)|Gets the native calling convention for the method that is represented by the specified signature pointer.| +|[GetNestedClassProps Method](imetadataimport-getnestedclassprops-method.md)|Gets the TypeDef token for the enclosing parent type of the specified nested type.| +|[GetParamForMethodIndex Method](imetadataimport-getparamformethodindex-method.md)|Gets a pointer to the token that represents the parameter at the specified ordinal position in the sequence of method parameters for the method represented by the specified MethodDef token.| +|[GetParamProps Method](imetadataimport-getparamprops-method.md)|Gets metadata values for the parameter referenced by the specified ParamDef token.| +|[GetPermissionSetProps Method](imetadataimport-getpermissionsetprops-method.md)|Gets the metadata associated with the System.Security.PermissionSet represented by the specified Permission token.| +|[GetPinvokeMap](imetadataimport-getpinvokemap-method.md)|Gets a ModuleRef token to represent the target assembly of a PInvoke call.| +|[GetPropertyProps Method](imetadataimport-getpropertyprops-method.md)|Gets the metadata associated with the property represented by the specified token.| +|[GetRVA Method](imetadataimport-getrva-method.md)|Gets the offset of the relative virtual address of the code object represented by the specified token.| +|[GetScopeProps Method](imetadataimport-getscopeprops-method.md)|Gets the name and optionally the version identifier of the assembly or module in the current metadata scope.| +|[GetSigFromToken Method](imetadataimport-getsigfromtoken-method.md)|Gets the binary metadata signature associated with the specified token.| +|[GetTypeDefProps Method](imetadataimport-gettypedefprops-method.md)|Returns metadata information for the type represented by the specified TypeDef token.| +|[GetTypeRefProps Method](imetadataimport-gettyperefprops-method.md)|Gets the metadata associated with the type referenced by the specified TypeRef token.| +|[GetTypeSpecFromToken Method](imetadataimport-gettypespecfromtoken-method.md)|Gets the binary metadata signature of the type specification represented by the specified token.| +|[GetUserString Method](imetadataimport-getuserstring-method.md)|Gets the literal string represented by the specified metadata token.| +|[IsGlobal Method](imetadataimport-isglobal-method.md)|Gets a value indicating whether the field, method, or type represented by the specified metadata token has global scope.| +|[IsValidToken Method](imetadataimport-isvalidtoken-method.md)|Gets a value indicating whether the specified token holds a valid reference to a code object.| +|[ResetEnum Method](imetadataimport-resetenum-method.md)|Resets the specified enumerator to the specified position.| +|[ResolveTypeRef Method](imetadataimport-resolvetyperef-method.md)|Gets type information for the type referenced by the specified TypeRef token.| + +## Remarks + + The design of the `IMetaDataImport` interface is intended primarily to be used by tools and services that will be importing type information (for example, development tools) or managing deployed components (for example, resolution/activation services). The methods in `IMetaDataImport` fall into the following task categories: + +- Enumerating collections of items in the metadata scope. + +- Finding an item that has a specific set of characteristics. + +- Getting properties of a specified item. + +- The Get methods are specifically designed to return single-valued properties of a metadata item. When the property is a reference to another item, a token for that item is returned. Any pointer input type can be NULL to indicate that the particular value is not being requested. To obtain properties that are essentially collection objects (for example, the collection of interfaces that a class implements), use the enumeration methods. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md new file mode 100644 index 0000000000000..b3f1cce92a41f --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataImport::IsGlobal Method" +title: "IMetaDataImport::IsGlobal Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.IsGlobal" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::IsGlobal" +helpviewer_keywords: + - "IsGlobal method [.NET Framework metadata]" + - "IMetaDataImport::IsGlobal method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::IsGlobal Method + +Gets a value indicating whether the field, method, or type represented by the specified metadata token has global scope. + +## Syntax + +```cpp +HRESULT IsGlobal ( + [in] mdToken pd, + [out] int *pbGlobal +); +``` + +## Parameters + + `pd` + [in] A metadata token that represents a type, field, or method. + + `pbGlobal` + [out] 1 if the object has global scope; otherwise, 0 (zero). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md new file mode 100644 index 0000000000000..51a1d533fc446 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataImport::IsValidToken Method" +title: "IMetaDataImport::IsValidToken Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.IsValidToken" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::IsValidToken" +helpviewer_keywords: + - "IMetaDataImport::IsValidToken method [.NET Framework metadata]" + - "IsValidToken method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::IsValidToken Method + +Gets a value indicating whether the specified token holds a valid reference to a code object. + +## Syntax + +```cpp +BOOL IsValidToken ( + [in] mdToken tk +); +``` + +## Parameters + + `tk` + [in] The token to check the reference validity for. + +## Return Value + + `true` if `tk` is a valid metadata token within the current scope. Otherwise, `false`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md new file mode 100644 index 0000000000000..4a8bfd32e7c01 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataImport::ResetEnum Method" +title: "IMetaDataImport::ResetEnum Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport.ResetEnum" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport::ResetEnum" +helpviewer_keywords: + - "ResetEnum method [.NET Framework metadata]" + - "IMetaDataImport::ResetEnum method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport::ResetEnum Method + +Resets the specified enumerator to the specified position. + +## Syntax + +```cpp +HRESULT ResetEnum ( + [in] HCORENUM hEnum, + [in] ULONG ulPos +); +``` + +## Parameters + + `hEnum` + [in] The enumerator to reset. + + `ulPos` + [in] The new position at which to place the enumerator. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md similarity index 66% rename from docs/framework/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md index 4c51aadfc1ea5..c3ebac75b7315 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md @@ -2,69 +2,68 @@ description: "Learn more about: IMetaDataImport::ResolveTypeRef Method" title: "IMetaDataImport::ResolveTypeRef Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.ResolveTypeRef" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::ResolveTypeRef" -helpviewer_keywords: +helpviewer_keywords: - "ResolveTypeRef method [.NET Framework metadata]" - "IMetaDataImport::ResolveTypeRef method [.NET Framework metadata]" -ms.assetid: 556bccfb-61bc-4761-b1d5-de4b1c18a38f -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::ResolveTypeRef Method -Resolves a reference represented by the specified TypeRef token. - -## Syntax - -```cpp -HRESULT ResolveTypeRef ( - [in] mdTypeRef tr, - [in] REFIID riid, - [out] IUnknown **ppIScope, - [out] mdTypeDef *ptd -); -``` - -## Parameters - - `tr` - [in] The TypeRef metadata token to return the referenced type information for. - - `riid` - [in] The IID of the interface to return in `ppIScope`. Typically, this would be IID_IMetaDataImport. - - `ppIScope` - [out] An interface to the module scope in which the referenced type is defined. - - `ptd` - [out] A pointer to a TypeDef token that represents the referenced type. - -## Remarks - +Resolves a reference represented by the specified TypeRef token. + +## Syntax + +```cpp +HRESULT ResolveTypeRef ( + [in] mdTypeRef tr, + [in] REFIID riid, + [out] IUnknown **ppIScope, + [out] mdTypeDef *ptd +); +``` + +## Parameters + + `tr` + [in] The TypeRef metadata token to return the referenced type information for. + + `riid` + [in] The IID of the interface to return in `ppIScope`. Typically, this would be IID_IMetaDataImport. + + `ppIScope` + [out] An interface to the module scope in which the referenced type is defined. + + `ptd` + [out] A pointer to a TypeDef token that represents the referenced type. + +## Remarks + > [!IMPORTANT] -> Do not use this method if multiple application domains are loaded. The method does not respect application domain boundaries. If multiple versions of an assembly are loaded, and they contain the same type with the same namespace, the method returns the module scope of the first type it finds. - - The `ResolveTypeRef` method searches for the type definition in other modules. If the type definition is found, `ResolveTypeRef` returns an interface to that module scope as well as the TypeDef token for the type. - - If the type reference to be resolved has a resolution scope of AssemblyRef, the `ResolveTypeRef` method searches for a match only in the metadata scopes that have already been opened with calls to either the [IMetaDataDispenser::OpenScope](imetadatadispenser-openscope-method.md) method or the [IMetaDataDispenser::OpenScopeOnMemory](imetadatadispenser-openscopeonmemory-method.md) method. This is because `ResolveTypeRef` cannot determine from only the AssemblyRef scope where on disk or in the global assembly cache the assembly is stored. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +> Do not use this method if multiple application domains are loaded. The method does not respect application domain boundaries. If multiple versions of an assembly are loaded, and they contain the same type with the same namespace, the method returns the module scope of the first type it finds. + + The `ResolveTypeRef` method searches for the type definition in other modules. If the type definition is found, `ResolveTypeRef` returns an interface to that module scope as well as the TypeDef token for the type. + + If the type reference to be resolved has a resolution scope of AssemblyRef, the `ResolveTypeRef` method searches for a match only in the metadata scopes that have already been opened with calls to either the [IMetaDataDispenser::OpenScope](imetadatadispenser-openscope-method.md) method or the [IMetaDataDispenser::OpenScopeOnMemory](imetadatadispenser-openscopeonmemory-method.md) method. This is because `ResolveTypeRef` cannot determine from only the AssemblyRef scope where on disk or in the global assembly cache the assembly is stored. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md index 8c54500b54afe..d40147908f98a 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport2::EnumGenericParamConstraints Method" title: "IMetaDataImport2::EnumGenericParamConstraints Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport2.EnumGenericParamConstraints" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport2::EnumGenericParamConstraints" -helpviewer_keywords: +helpviewer_keywords: - "EnumGenericParamConstraints method [.NET Framework metadata]" - "IMetaDataImport2::EnumGenericParamConstraints method [.NET Framework metadata]" -ms.assetid: 8a7d4e40-28fe-4e14-b801-4049880130e7 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport2::EnumGenericParamConstraints Method -Gets an enumerator for an array of generic parameter constraints associated with the generic parameter represented by the specified token. - -## Syntax - -```cpp -HRESULT EnumGenericParamConstraints ( - [in, out] HCORENUM *phEnum, - [in] mdGenericParam tk, - [out] mdGenericParamConstraint rGenericParamConstraints[], - [in] ULONG cMax, - [out] ULONG *pcGenericParamConstraints -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. - - `tk` - [in] A token that represents the generic parameter whose constraints are to be enumerated. - - `rGenericParamConstraints` - [out] The array of generic parameter constraints to enumerate. - - `cMax` - [in] The requested maximum number of tokens to place in `rGenericParamConstraints`. - - `pcGenericParamConstraints` - [out] A pointer to the number of tokens placed in `rGenericParamConstraints`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumGenericParameterConstraints` returned successfully.| -|`S_FALSE`|`phEnum` has no member elements. In this case, `pcGenericParameterConstraints` is set to 0 (zero).| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets an enumerator for an array of generic parameter constraints associated with the generic parameter represented by the specified token. + +## Syntax + +```cpp +HRESULT EnumGenericParamConstraints ( + [in, out] HCORENUM *phEnum, + [in] mdGenericParam tk, + [out] mdGenericParamConstraint rGenericParamConstraints[], + [in] ULONG cMax, + [out] ULONG *pcGenericParamConstraints +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. + + `tk` + [in] A token that represents the generic parameter whose constraints are to be enumerated. + + `rGenericParamConstraints` + [out] The array of generic parameter constraints to enumerate. + + `cMax` + [in] The requested maximum number of tokens to place in `rGenericParamConstraints`. + + `pcGenericParamConstraints` + [out] A pointer to the number of tokens placed in `rGenericParamConstraints`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumGenericParameterConstraints` returned successfully.| +|`S_FALSE`|`phEnum` has no member elements. In this case, `pcGenericParameterConstraints` is set to 0 (zero).| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md new file mode 100644 index 0000000000000..bbe86a5e3531e --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport2::EnumGenericParams Method" +title: "IMetaDataImport2::EnumGenericParams Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport2.EnumGenericParams" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport2::EnumGenericParams" +helpviewer_keywords: + - "EnumGenericParams method [.NET Framework metadata]" + - "IMetaDataImport2::EnumGenericParams method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport2::EnumGenericParams Method + +Gets an enumerator for an array of generic parameter tokens associated with the specified TypeDef or MethodDef token. + +## Syntax + +```cpp +HRESULT EnumGenericParams ( + [in, out] HCORENUM *phEnum, + [in] mdToken tk, + [out] mdGenericParam rGenericParams[], + [in] ULONG cMax, + [out] ULONG *pcGenericParams +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator. + + `tk` + [in] The TypeDef or MethodDef token whose generic parameters are to be enumerated. + + `rGenericParams` + [out] The array of generic parameters to enumerate. + + `cMax` + [in] The requested maximum number of tokens to place in `rGenericParams`. + + `pcGenericParams` + [out] The returned number of tokens placed in `rGenericParams`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumGenericParams` returned successfully.| +|`S_FALSE`|`phEnum` has no member elements. In this case, `pcGenericParams` is set to 0 (zero).| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) +- [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md new file mode 100644 index 0000000000000..8de58087c5190 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md @@ -0,0 +1,72 @@ +--- +description: "Learn more about: IMetaDataImport2::EnumMethodSpecs Method" +title: "IMetaDataImport2::EnumMethodSpecs Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport2.EnumMethodSpecs" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport2::EnumMethodSpecs" +helpviewer_keywords: + - "IMetaDataImport2::EnumMethodSpecs method [.NET Framework metadata]" + - "EnumMethodSpecs method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport2::EnumMethodSpecs Method + +Gets an enumerator for an array of MethodSpec tokens associated with the specified MethodDef or MemberRef token. + +## Syntax + +```cpp +HRESULT EnumMethodSpecs ( + [in, out] HCORENUM *phEnum, + [in] mdToken tk, + [out] mdMethodSpec rMethodSpecs[], + [in] ULONG cMax, + [out] ULONG *pcMethodSpecs +); +``` + +## Parameters + + `phEnum` + [in, out] A pointer to the enumerator for `rMethodSpecs`. + + `tk` + [in] The MemberRef or MethodDef token that represents the method whose MethodSpec tokens are to be enumerated. If the value of `tk` is 0 (zero), all MethodSpec tokens in the scope will be enumerated. + + `rMethodSpecs` + [out] The array of MethodSpec tokens to enumerate. + + `cMax` + [in] The requested maximum number of tokens to place in `rMethodSpecs`. + + `pcMethodSpecs` + [out] The returned number of tokens placed in `rMethodSpecs`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|`EnumMethodSpecs` returned successfully.| +|`S_FALSE`|`phEnum` has no member elements. In this case, `pcMethodSpecs` is set to 0 (zero).| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) +- [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md index 7c0298f8865d8..b412e3f269a8a 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport2::GetGenericParamConstraintProps Method" title: "IMetaDataImport2::GetGenericParamConstraintProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport2.GetGenericParamConstraintProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport2::GetGenericParamConstraintProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport2::GetGenericParamConstraintProps method [.NET Framework metadata]" - "GetGenericParamConstraintProps method [.NET Framework metadata]" -ms.assetid: c5fee4a0-b132-4e5e-8730-e586ce314b9a -topic_type: +topic_type: - "apiref" --- # IMetaDataImport2::GetGenericParamConstraintProps Method -Gets the metadata associated with the generic parameter constraint represented by the specified constraint token. - -## Syntax - -```cpp -HRESULT GetGenericParamConstraintProps ( - [in] mdGenericParamConstraint gpc, - [out] mdGenericParam *ptGenericParam, - [out] mdToken *ptkConstraintType -); -``` - -## Parameters - - `gpc` - [in] The token to the generic parameter constraint for which to return the metadata. - - `ptGenericParam` - [out] A pointer to the token that represents the generic parameter that is constrained. - - `ptkConstraintType` - [out] A pointer to a TypeDef, TypeRef, or TypeSpec token that represents a constraint on `ptGenericParam`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets the metadata associated with the generic parameter constraint represented by the specified constraint token. + +## Syntax + +```cpp +HRESULT GetGenericParamConstraintProps ( + [in] mdGenericParamConstraint gpc, + [out] mdGenericParam *ptGenericParam, + [out] mdToken *ptkConstraintType +); +``` + +## Parameters + + `gpc` + [in] The token to the generic parameter constraint for which to return the metadata. + + `ptGenericParam` + [out] A pointer to the token that represents the generic parameter that is constrained. + + `ptkConstraintType` + [out] A pointer to a TypeDef, TypeRef, or TypeSpec token that represents a constraint on `ptGenericParam`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md new file mode 100644 index 0000000000000..717b8e48d624b --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md @@ -0,0 +1,77 @@ +--- +description: "Learn more about: IMetaDataImport2::GetGenericParamProps Method" +title: "IMetaDataImport2::GetGenericParamProps Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport2.GetGenericParamProps" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport2::GetGenericParamProps" +helpviewer_keywords: + - "IMetaDataImport2::GetGenericParamProps method [.NET Framework metadata]" + - "GetGenericParamProps method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport2::GetGenericParamProps Method + +Gets the metadata associated with the generic parameter represented by the specified token. + +## Syntax + +```cpp +HRESULT GetGenericParamProps ( + [in] mdGenericParam gp, + [out] ULONG *pulParamSeq, + [out] DWORD *pdwParamFlags, + [out] mdToken *ptOwner, + [out] DWORD *reserved, + [out] LPWSTR wzName, + [in] ULONG cchName, + [out] ULONG *pchName +); +``` + +## Parameters + + `gp` + [in] The token that represents the generic parameter for which to return metadata. + + `pulParamSeq` + [out] The ordinal position of the `Type` parameter in the parent constructor or method. + + `pdwParamFlags` + [out] A value of the [CorGenericParamAttr](corgenericparamattr-enumeration.md) enumeration that describes the `Type` for the generic parameter. + + `ptOwner` + [out] A TypeDef or MethodDef token that represents the owner of the parameter. + + `reserved` + [out] Reserved for future extensibility. + + `wzName` + [out] The name of the generic parameter. + + `cchName` + [in] The size of the `wzName` buffer. + + `pchName` + [out] The returned size of the name, in wide characters. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) +- [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md index 5c37ab4e40286..eb235eb454063 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataImport2::GetMethodSpecProps Method" title: "IMetaDataImport2::GetMethodSpecProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport2.GetMethodSpecProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport2::GetMethodSpecProps" -helpviewer_keywords: +helpviewer_keywords: - "GetMethodSpecProps method [.NET Framework metadata]" - "IMetaDataImport2::GetMethodSpecProps method [.NET Framework metadata]" -ms.assetid: 9544b711-e669-4eaf-8630-ee862e5e4489 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport2::GetMethodSpecProps Method -Gets the metadata signature of the method referenced by the specified MethodSpec token. - -## Syntax - -```cpp -HRESULT GetMethodSpecProps ( - [in] mdMethodSpec mi, - [out] mdToken *tkParent, +Gets the metadata signature of the method referenced by the specified MethodSpec token. + +## Syntax + +```cpp +HRESULT GetMethodSpecProps ( + [in] mdMethodSpec mi, + [out] mdToken *tkParent, [out] PCCOR_SIGNATURE *ppvSigBlob, - [out] ULONG *pcbSigBlob + [out] ULONG *pcbSigBlob ); -``` - -## Parameters - - `mi` - [in] A MethodSpec token that represents the instantiation of the method. - - `tkParent` - [out] A pointer to the MethodDef or MethodRef token that represents the method definition. - - `ppvSigBlob` - [out] A pointer to the binary metadata signature of the method. - - `pcbSigBlob` - [out] The size, in bytes, of `ppvSigBlob`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +``` + +## Parameters + + `mi` + [in] A MethodSpec token that represents the instantiation of the method. + + `tkParent` + [out] A pointer to the MethodDef or MethodRef token that represents the method definition. + + `ppvSigBlob` + [out] A pointer to the binary metadata signature of the method. + + `pcbSigBlob` + [out] The size, in bytes, of `ppvSigBlob`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md new file mode 100644 index 0000000000000..5bc3574a94464 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md @@ -0,0 +1,64 @@ +--- +description: "Learn more about: IMetaDataImport2::GetPEKind Method" +title: "IMetaDataImport2::GetPEKind Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataImport2.GetPEKind" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataImport2::GetPEKind" +helpviewer_keywords: + - "GetPEKind method [.NET Framework metadata]" + - "IMetaDataImport2::GetPEKind method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataImport2::GetPEKind Method + +Gets a value identifying the nature of the code in the portable executable (PE) file, typically a DLL or EXE file, that is defined in the current metadata scope. + +## Syntax + +```cpp +HRESULT GetPEKind ( + [out] DWORD *pdwPEKind, + [out] DWORD *pdwMachine +); +``` + +## Parameters + + `pdwPEKind` + [out] A pointer to a value of the [CorPEKind](corpekind-enumeration.md) enumeration that describes the PE file. + + `pdwMachine` + [out] A pointer to a value that identifies the architecture of the machine. See the next section for possible values. + +## Remarks + + The value referenced by the `pdwMachine` parameter can be one of the following. + +|Value|Machine architecture| +|-----------|--------------------------| +|IMAGE_FILE_MACHINE_I386

0x014C|x86| +|IMAGE_FILE_MACHINE_IA64

0x0200|Intel IPF| +|IMAGE_FILE_MACHINE_AMD64

0x8664|x64| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataImport2 Interface](imetadataimport2-interface.md) +- [IMetaDataImport Interface](imetadataimport-interface.md) +- [CorPEKind Enumeration](corpekind-enumeration.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md index dc4bd3f4597ca..3462169c1f555 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataImport2::GetVersionString Method" title: "IMetaDataImport2::GetVersionString Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport2.GetVersionString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport2::GetVersionString" -helpviewer_keywords: +helpviewer_keywords: - "GetVersionString method, IMetaDataImport2 interface [.NET Framework metadata]" - "IMetaDataImport2::GetVersionString method [.NET Framework metadata]" -ms.assetid: 308183ee-fd44-4432-9d86-ef00d181b49b -topic_type: +topic_type: - "apiref" --- # IMetaDataImport2::GetVersionString Method -Gets the version number of the runtime that was used to build the assembly. - -## Syntax - -```cpp -HRESULT GetVersionString ( - [out] LPWSTR pwzBuf, - [in] DWORD ccBufSize, - [out] DWORD *pccBufSize -); -``` - -## Parameters - - `pwzBuf` - [out] An array to store the string that specifies the version. - - `ccBufSize` - [in] The size, in wide characters, of the `pwzBuf` array. - - `pccBufSize` - [out] The number of wide characters, including a null terminator, returned in the `pwzBuf` array. - -## Remarks - - The `GetVersionString` method gets the built-for version of the current metadata scope. If the scope has never been saved, it will not have a built-for version, and an empty string will be returned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets the version number of the runtime that was used to build the assembly. + +## Syntax + +```cpp +HRESULT GetVersionString ( + [out] LPWSTR pwzBuf, + [in] DWORD ccBufSize, + [out] DWORD *pccBufSize +); +``` + +## Parameters + + `pwzBuf` + [out] An array to store the string that specifies the version. + + `ccBufSize` + [in] The size, in wide characters, of the `pwzBuf` array. + + `pccBufSize` + [out] The number of wide characters, including a null terminator, returned in the `pwzBuf` array. + +## Remarks + + The `GetVersionString` method gets the built-for version of the current metadata scope. If the scope has never been saved, it will not have a built-for version, and an empty string will be returned. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md similarity index 68% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-interface.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-interface.md index e484c25379eb0..4e3ee9fe58e41 100644 --- a/docs/framework/unmanaged-api/metadata/imetadataimport2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md @@ -2,47 +2,46 @@ description: "Learn more about: IMetaDataImport2 Interface" title: "IMetaDataImport2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport2" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport2 interface [.NET Framework metadata]" -ms.assetid: d39b2b87-ba53-4771-ae53-952a68452511 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport2 Interface -Extends the [IMetaDataImport](imetadataimport-interface.md) interface to provide the capability of working with generic types. - -## Methods - -|Method|Description| -|------------|-----------------| -|[EnumGenericParamConstraints Method](imetadataimport2-enumgenericparamconstraints-method.md)|Gets an enumerator for an array of generic parameter constraints associated with the generic parameter represented by the specified token.| -|[EnumGenericParams Method](imetadataimport2-enumgenericparams-method.md)|Gets an enumerator for an array of generic parameter tokens associated with the specified TypeDef or MethodDef token.| -|[EnumMethodSpecs Method](imetadataimport2-enummethodspecs-method.md)|Gets an enumerator for an array of MethodSpec tokens associated with the specified MethodDef or MemberRef token.| -|[GetGenericParamConstraintProps Method](imetadataimport2-getgenericparamconstraintprops-method.md)|Gets the metadata associated with the generic parameter constraint represented by the specified constraint token.| -|[GetGenericParamProps Method](imetadataimport2-getgenericparamprops-method.md)|Gets the metadata associated with the generic parameter represented by the specified token.| -|[GetMethodSpecProps Method](imetadataimport2-getmethodspecprops-method.md)|Gets the metadata signature of the method referenced by the specified MethodSpec token.| -|[GetPEKind Method](imetadataimport2-getpekind-method.md)|Gets a value identifying the nature of the code in a portable executable (PE) file, typically a DLL or EXE file, defined in the current metadata scope| -|[GetVersionString Method](imetadataimport2-getversionstring-method.md)|Gets the version number of the runtime that was used to build the assembly.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Extends the [IMetaDataImport](imetadataimport-interface.md) interface to provide the capability of working with generic types. + +## Methods + +|Method|Description| +|------------|-----------------| +|[EnumGenericParamConstraints Method](imetadataimport2-enumgenericparamconstraints-method.md)|Gets an enumerator for an array of generic parameter constraints associated with the generic parameter represented by the specified token.| +|[EnumGenericParams Method](imetadataimport2-enumgenericparams-method.md)|Gets an enumerator for an array of generic parameter tokens associated with the specified TypeDef or MethodDef token.| +|[EnumMethodSpecs Method](imetadataimport2-enummethodspecs-method.md)|Gets an enumerator for an array of MethodSpec tokens associated with the specified MethodDef or MemberRef token.| +|[GetGenericParamConstraintProps Method](imetadataimport2-getgenericparamconstraintprops-method.md)|Gets the metadata associated with the generic parameter constraint represented by the specified constraint token.| +|[GetGenericParamProps Method](imetadataimport2-getgenericparamprops-method.md)|Gets the metadata associated with the generic parameter represented by the specified token.| +|[GetMethodSpecProps Method](imetadataimport2-getmethodspecprops-method.md)|Gets the metadata signature of the method referenced by the specified MethodSpec token.| +|[GetPEKind Method](imetadataimport2-getpekind-method.md)|Gets a value identifying the nature of the code in a portable executable (PE) file, typically a DLL or EXE file, defined in the current metadata scope| +|[GetVersionString Method](imetadataimport2-getversionstring-method.md)|Gets the version number of the runtime that was used to build the assembly.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - diff --git a/docs/framework/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md similarity index 69% rename from docs/framework/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md rename to docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md index 811dde6dcce9c..3c444bc789a68 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md @@ -2,74 +2,73 @@ description: "Learn more about: IMetaDataInfo::GetFileMapping Method" title: "IMetaDataInfo::GetFileMapping Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataInfo.GetFileMapping" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataInfo::GetFileMapping" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataInfo::GetFileMapping method [.NET Framework metadata]" - "GetFileMapping method [.NET Framework metadata]" -ms.assetid: 2868dfec-c992-4606-88bb-a8e0b6b18271 -topic_type: +topic_type: - "apiref" --- # IMetaDataInfo::GetFileMapping Method -Gets the memory region of the mapped file, and the type of mapping. - -## Syntax - -```cpp -HRESULT GetFileMapping ( +Gets the memory region of the mapped file, and the type of mapping. + +## Syntax + +```cpp +HRESULT GetFileMapping ( [out] const void **ppvData, [out] ULONGLONG *pcbData, - [out] DWORD *pdwMappingType -); -``` - -## Parameters - - `ppvData` - [out] A pointer to the start of the mapped file. - - `pcbData` - [out] The size of the mapped region. If `pdwMappingType` is `fmFlat`, this is the size of the file. - - `pdwMappingType` - [out] A [CorFileMapping](corfilemapping-enumeration.md) value that indicates the type of mapping. The current implementation of the common language runtime (CLR) always returns `fmFlat`. Other values are reserved for future use. However, you should always verify the returned value, because other values may be enabled in future versions or service releases. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|All outputs are filled.| -|`E_INVALIDARG`|NULL was passed as an argument value.| -|`COR_E_NOTSUPPORTED`|The CLR implementation cannot provide information about the memory region. This can happen for the following reasons:

- The metadata scope was opened with the `ofWrite` or `ofCopyMemory` flag.
- The metadata scope was opened without the `ofReadOnly` flag.
- The [IMetaDataDispenser::OpenScopeOnMemory](imetadatadispenser-openscopeonmemory-method.md) method was used to open only the metadata portion of the file.
- The file is not a portable executable (PE) file. **Note:** These conditions depend on the CLR implementation, and are likely to be weakened in future versions of the CLR.| - -## Remarks - - The memory that `ppvData` points to is valid only as long as the underlying metadata scope is open. - - In order for this method to work, when you map the metadata of an on-disk file into memory by calling the [IMetaDataDispenser::OpenScope](imetadatadispenser-openscope-method.md) method, you must specify the `ofReadOnly` flag and you must not specify the `ofWrite` or `ofCopyMemory` flag. - - The choice of file mapping type for each scope is specific to a given implementation of the CLR. It cannot be set by the user. The current implementation of the CLR always returns `fmFlat` in `pdwMappingType`, but this can change in future versions of the CLR or in future service releases of a given version. You should always check the returned value in `pdwMappingType`, because different types will have different layouts and offsets. - - Passing NULL for any of the three parameters is not supported. The method returns `E_INVALIDARG`, and none of the outputs are filled. Ignoring the mapping type or the size of the region can result in abnormal program termination. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - + [out] DWORD *pdwMappingType +); +``` + +## Parameters + + `ppvData` + [out] A pointer to the start of the mapped file. + + `pcbData` + [out] The size of the mapped region. If `pdwMappingType` is `fmFlat`, this is the size of the file. + + `pdwMappingType` + [out] A [CorFileMapping](corfilemapping-enumeration.md) value that indicates the type of mapping. The current implementation of the common language runtime (CLR) always returns `fmFlat`. Other values are reserved for future use. However, you should always verify the returned value, because other values may be enabled in future versions or service releases. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|`S_OK`|All outputs are filled.| +|`E_INVALIDARG`|NULL was passed as an argument value.| +|`COR_E_NOTSUPPORTED`|The CLR implementation cannot provide information about the memory region. This can happen for the following reasons:

- The metadata scope was opened with the `ofWrite` or `ofCopyMemory` flag.
- The metadata scope was opened without the `ofReadOnly` flag.
- The [IMetaDataDispenser::OpenScopeOnMemory](imetadatadispenser-openscopeonmemory-method.md) method was used to open only the metadata portion of the file.
- The file is not a portable executable (PE) file. **Note:** These conditions depend on the CLR implementation, and are likely to be weakened in future versions of the CLR.| + +## Remarks + + The memory that `ppvData` points to is valid only as long as the underlying metadata scope is open. + + In order for this method to work, when you map the metadata of an on-disk file into memory by calling the [IMetaDataDispenser::OpenScope](imetadatadispenser-openscope-method.md) method, you must specify the `ofReadOnly` flag and you must not specify the `ofWrite` or `ofCopyMemory` flag. + + The choice of file mapping type for each scope is specific to a given implementation of the CLR. It cannot be set by the user. The current implementation of the CLR always returns `fmFlat` in `pdwMappingType`, but this can change in future versions of the CLR or in future service releases of a given version. You should always check the returned value in `pdwMappingType`, because different types will have different layouts and offsets. + + Passing NULL for any of the three parameters is not supported. The method returns `E_INVALIDARG`, and none of the outputs are filled. Ignoring the mapping type or the size of the region can result in abnormal program termination. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [IMetaDataInfo Interface](imetadatainfo-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatainfo-interface.md b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md similarity index 51% rename from docs/framework/unmanaged-api/metadata/imetadatainfo-interface.md rename to docs/core/unmanaged-api/metadata/imetadatainfo-interface.md index dda640c08c1d3..b48fba1d402c1 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatainfo-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md @@ -2,40 +2,39 @@ description: "Learn more about: IMetaDataInfo Interface" title: "IMetaDataInfo Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataInfo" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataInfo interface [.NET Framework metadata]" -ms.assetid: 137cb264-64de-46ac-bc6e-2a7db97e8abe -topic_type: +topic_type: - "apiref" --- # IMetaDataInfo Interface -Provides a method that gets information about the mapping of metadata from an on-disk file into memory. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetFileMapping Method](imetadatainfo-getfilemapping-method.md)|Gets the memory region of the mapped file, and the kind of mapping.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Provides a method that gets information about the mapping of metadata from an on-disk file into memory. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetFileMapping Method](imetadatainfo-getfilemapping-method.md)|Gets the memory region of the mapped file, and the kind of mapping.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md new file mode 100644 index 0000000000000..fd0867fee6b8a --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: IMetaDataTables::GetBlob Method" +title: "IMetaDataTables::GetBlob Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables.GetBlob" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables::GetBlob" +helpviewer_keywords: + - "GetBlob method [.NET Framework metadata]" + - "IMetaDataTables::GetBlob method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables::GetBlob Method + +Gets a pointer to the binary large object (BLOB) at the specified column index. + +## Syntax + +```cpp +HRESULT GetBlob ( + [in] ULONG ixBlob, + [out] ULONG *pcbData, + [out] const void **ppData +); +``` + +## Parameters + + `ixBlob` + [in] The memory address from which to get `ppData`. + + `pcbData` + [out] A pointer to the size, in bytes, of `ppData`. + + `ppData` + [out] A pointer to a pointer to the binary data retrieved. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataTables Interface](imetadatatables-interface.md) +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md index 700b745c92280..5874806c116de 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataTables::GetBlobHeapSize Method" title: "IMetaDataTables::GetBlobHeapSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetBlobHeapSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetBlobHeapSize" -helpviewer_keywords: +helpviewer_keywords: - "GetBlobHeapSize method [.NET Framework metadata]" - "IMetaDataTables::GetBlobHeapSize method [.NET Framework metadata]" -ms.assetid: 6330a9ee-8cd5-4299-86f1-b4de2c701a0d -topic_type: +topic_type: - "apiref" --- # IMetaDataTables::GetBlobHeapSize Method -Gets the size, in bytes, of the binary large object (BLOB) heap. - -## Syntax - -```cpp -HRESULT GetBlobHeapSize ( - [out] ULONG *pcbBlobs +Gets the size, in bytes, of the binary large object (BLOB) heap. + +## Syntax + +```cpp +HRESULT GetBlobHeapSize ( + [out] ULONG *pcbBlobs ); -``` - -## Parameters - - `pcbBlobs` - [out] A pointer to the size, in bytes, of the BLOB heap. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +``` + +## Parameters + + `pcbBlobs` + [out] A pointer to the size, in bytes, of the BLOB heap. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md new file mode 100644 index 0000000000000..ad051c5cf5340 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md @@ -0,0 +1,61 @@ +--- +description: "Learn more about: IMetaDataTables::GetCodedTokenInfo Method" +title: "IMetaDataTables::GetCodedTokenInfo Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables.GetCodedTokenInfo" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables::GetCodedTokenInfo" +helpviewer_keywords: + - "GetCodedTokenInfo method [.NET Framework metadata]" + - "IMetaDataTables::GetCodedTokenInfo method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables::GetCodedTokenInfo Method + +Gets a pointer to an array of tokens associated with the specified row index. + +## Syntax + +```cpp +HRESULT GetCodedTokenInfo ( + [in] ULONG ixCdTkn, + [out] ULONG *pcTokens, + [out] ULONG **ppTokens, + [out] const char **ppName +); +``` + +## Parameters + + `ixCdTkn` + [in] The kind of coded token to return. + + `pcTokens` + [out] A pointer to the length of `ppTokens`. + + `ppTokens` + [out] A pointer to a pointer to an array that contains the list of returned tokens. + + `ppName` + [out] A pointer to a pointer to the name of the token at `ixCdTkn`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataTables Interface](imetadatatables-interface.md) +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getcolumn-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md similarity index 75% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getcolumn-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md index ccfbf0936f4b6..c31145c7ad910 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getcolumn-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md @@ -2,49 +2,48 @@ description: "Learn more about: IMetaDataTables::GetColumn Method" title: "IMetaDataTables::GetColumn Method" ms.date: "02/25/2019" -api_name: +api_name: - "IMetaDataTables.GetColumn" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetColumn" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables::GetColumn method [.NET Framework metadata]" - "GetColumn method [.NET Framework metadata]" -ms.assetid: 1032055b-cabb-45c5-a50e-7e853201b175 -topic_type: +topic_type: - "apiref" --- # IMetaDataTables::GetColumn Method -Gets a pointer to the value contained in the cell of the specified column and row in the given table. - -## Syntax - -```cpp +Gets a pointer to the value contained in the cell of the specified column and row in the given table. + +## Syntax + +```cpp HRESULT GetColumn ( - [in] ULONG ixTbl, - [in] ULONG ixCol, - [in] ULONG rid, - [out] ULONG *pVal -); -``` - + [in] ULONG ixTbl, + [in] ULONG ixCol, + [in] ULONG rid, + [out] ULONG *pVal +); +``` + ## Parameters - `ixTbl` - [in] The index of the table. - - `ixCol` - [in] The index of the column in the table. - - `rid` - [in] The index of the row in the table. - - `pVal` - [out] A pointer to the value in the cell. + `ixTbl` + [in] The index of the table. + + `ixCol` + [in] The index of the column in the table. + + `rid` + [in] The index of the row in the table. + + `pVal` + [out] A pointer to the value in the cell. ## Remarks @@ -66,17 +65,17 @@ The interpretation of the value returned through `pVal` depends on the column's | `iSTRING` (101) | String heap index | *pVal* is an index into the String heap. Use [IMetadataTables::GetString](imetadatatables-getstring-method.md) to get the actual column String value. | | `iGUID` (102) | Guid heap index | *pVal* is an index into the Guid heap. Use [IMetadataTables::GetGuid](imetadatatables-getguid-method.md) to get the actual column Guid value. | | `iBLOB` (103) | Blob heap index | *pVal* is an index into the Blob heap. Use [IMetadataTables::GetBlob](imetadatatables-getblob-method.md) to get the actual column Blob value. | - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET Framework Versions** Available since .NET Framework 2.0 + ## See also - [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md similarity index 64% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md index b1fd994d525fe..9ce5a9a71c027 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md @@ -2,59 +2,58 @@ description: "Learn more about: IMetaDataTables::GetColumnInfo Method" title: "IMetaDataTables::GetColumnInfo Method" ms.date: "10/10/2019" -api_name: +api_name: - "IMetaDataTables.GetColumnInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetColumnInfo" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables::GetColumnInfo method [.NET Framework metadata]" - "GetColumnInfo method [.NET Framework metadata]" -ms.assetid: 68c160ea-ae7d-4750-985d-a038b2c8e7d9 -topic_type: +topic_type: - "apiref" --- # IMetaDataTables::GetColumnInfo Method -Gets data about the specified column in the specified table. - -## Syntax - -```cpp +Gets data about the specified column in the specified table. + +## Syntax + +```cpp HRESULT GetColumnInfo ( - [in] ULONG ixTbl, - [in] ULONG ixCol, - [out] ULONG *poCol, - [out] ULONG *pcbCol, - [out] ULONG *pType, - [out] const char **ppName -); -``` - + [in] ULONG ixTbl, + [in] ULONG ixCol, + [out] ULONG *poCol, + [out] ULONG *pcbCol, + [out] ULONG *pType, + [out] const char **ppName +); +``` + ## Parameters ======= - `ixTbl` - [in] The index of the desired table. - - `ixCol` - [in] The index of the desired column. - - `poCol` - [out] A pointer to the offset of the column in the row. - - `pcbCol` - [out] A pointer to the size, in bytes, of the column. - - `pType` - [out] A pointer to the type of the values in the column. - - `ppName` - [out] A pointer to a pointer to the column name. + `ixTbl` + [in] The index of the desired table. + + `ixCol` + [in] The index of the desired column. + + `poCol` + [out] A pointer to the offset of the column in the row. + + `pcbCol` + [out] A pointer to the size, in bytes, of the column. + + `pType` + [out] A pointer to the type of the values in the column. + + `ppName` + [out] A pointer to a pointer to the column name. ## Remarks @@ -82,16 +81,16 @@ Values that are stored in the *heap* (that is, `IsHeapType == true`) can be read > [!IMPORTANT] > To use the constants defined in the table above, include the directive `#define _DEFINE_META_DATA_META_CONSTANTS` provided by the *cor.h* header file. -## Requirements +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - ## See also - [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md similarity index 86% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getguid-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md index fd8257bd15b4f..1471d63186084 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getguid-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "GetGuid method [.NET Framework metadata]" - "IMetaDataTables::GetGuid method [.NET Framework metadata]" -ms.assetid: a3546316-e24d-417f-9909-e45d42c9d471 topic_type: - "apiref" --- @@ -44,13 +43,13 @@ HRESULT GetGuid ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h **Library:** Used as a resource in MsCorEE.dll - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + **.NET versions:** Available since .NET Framework 1.0 ## See also diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md new file mode 100644 index 0000000000000..5f6176abd48f0 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: IMetaDataTables::GetGuidHeapSize Method" +title: "IMetaDataTables::GetGuidHeapSize Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables.GetGuidHeapSize" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables::GetGuidHeapSize" +helpviewer_keywords: + - "GetGuidHeapSize method [.NET Framework metadata]" + - "IMetaDataTables::GetGuidHeapSize method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables::GetGuidHeapSize Method + +Gets the size, in bytes, of the GUID heap. + +## Syntax + +```cpp +HRESULT GetGuidHeapSize ( + [out] ULONG *pcbGuids +); +``` + +## Parameters + + `pcbGuids` + [out] A pointer to the size, in bytes, of the GUID heap. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataTables Interface](imetadatatables-interface.md) +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md new file mode 100644 index 0000000000000..dc05b39d3a0fe --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataTables::GetNextBlob Method" +title: "IMetaDataTables::GetNextBlob Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables.GetNextBlob" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables::GetNextBlob" +helpviewer_keywords: + - "IMetaDataTables::GetNextBlob method [.NET Framework metadata]" + - "GetNextBlob method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables::GetNextBlob Method + +Gets the index of the next binary large object (BLOB) in the table. + +## Syntax + +```cpp +HRESULT GetNextBlob ( + [in] ULONG ixBlob, + [out] ULONG *pNext +); +``` + +## Parameters + + `ixBlob` + [in] The index, as returned from a column of BLOBs. + + `pNext` + [out] A pointer to the index of the next BLOB. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataTables Interface](imetadatatables-interface.md) +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md similarity index 86% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getnextguid-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md index 23a6a7b22f6cf..9059952e3694e 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextguid-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "GetNextGuid method [.NET Framework metadata]" - "IMetaDataTables::GetNextGuid method [.NET Framework metadata]" -ms.assetid: 68f6ea4d-9112-4d6b-93d9-e34f1e2f2496 topic_type: - "apiref" --- @@ -44,13 +43,13 @@ HRESULT GetNextGuid ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h **Library:** Used as a resource in MsCorEE.dll - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + **.NET versions:** Available since .NET Framework 2.0 ## See also diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md new file mode 100644 index 0000000000000..e639550134f9d --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataTables::GetNextString Method" +title: "IMetaDataTables::GetNextString Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables.GetNextString" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables::GetNextString" +helpviewer_keywords: + - "IMetaDataTables::GetNextString method [.NET Framework metadata]" + - "GetNextString method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables::GetNextString Method + +Gets the index of the next string in the current table column. + +## Syntax + +```cpp +HRESULT GetNextString ( + [in] ULONG ixString, + [out] ULONG *pNext +); +``` + +## Parameters + + `ixString` + [in] The index value from a string table column. + + `pNext` + [out] A pointer to the index of the next string in the column. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataTables Interface](imetadatatables-interface.md) +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md similarity index 87% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md index 54d7859d9d127..e3ce366838ab4 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "GetNextUserString method [.NET Framework metadata]" - "IMetaDataTables::GetNextUserString method [.NET Framework metadata]" -ms.assetid: b7cb40ee-67b7-4f4e-8dcc-ee7ac8bc986b topic_type: - "apiref" --- @@ -44,13 +43,13 @@ HRESULT GetNextUserString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h **Library:** Used as a resource in MsCorEE.dll - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + **.NET versions:** Available since .NET Framework 1.0 ## See also diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getnumtables-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getnumtables-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md index 094fb83c404aa..60cc2a389e886 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getnumtables-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataTables::GetNumTables Method" title: "IMetaDataTables::GetNumTables Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetNumTables" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetNumTables" -helpviewer_keywords: +helpviewer_keywords: - "GetNumTables method [.NET Framework metadata]" - "IMetaDataTables::GetNumTables method [.NET Framework metadata]" -ms.assetid: 8196f2a3-bbf2-45d3-a6cd-74502c356644 -topic_type: +topic_type: - "apiref" --- # IMetaDataTables::GetNumTables Method -Gets the number of tables in the scope of the current `IMetaDataTables` instance. - -## Syntax - -```cpp -HRESULT GetNumTables ( - [out] ULONG *pcTables -); -``` - -## Parameters - - `pcTables` - [out] A pointer to the number of tables in the current instance scope. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the number of tables in the scope of the current `IMetaDataTables` instance. + +## Syntax + +```cpp +HRESULT GetNumTables ( + [out] ULONG *pcTables +); +``` + +## Parameters + + `pcTables` + [out] A pointer to the number of tables in the current instance scope. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getrow-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md similarity index 86% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getrow-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md index eca5ba32f9fd0..2a3fdc1f50606 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getrow-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "IMetaDataTables::GetRow method [.NET Framework metadata]" - "GetRow method [.NET Framework metadata]" -ms.assetid: a7408d51-0bce-45a2-b58f-da4660bbc039 topic_type: - "apiref" --- @@ -48,13 +47,13 @@ HRESULT GetRow ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h **Library:** Used as a resource in MsCorEE.dll - **.NET Framework Versions** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + **.NET Framework Versions** Available since .NET Framework 1.0 ## See also diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md new file mode 100644 index 0000000000000..9152385b51be3 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataTables::GetString Method" +title: "IMetaDataTables::GetString Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables.GetString" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables::GetString" +helpviewer_keywords: + - "IMetaDataTables::GetString method [.NET Framework metadata]" + - "GetString method, IMetaDataTables interface [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables::GetString Method + +Gets the string at the specified index from the table column in the current reference scope. + +## Syntax + +```cpp +HRESULT GetString ( + [in] ULONG ixString, + [out] const char **ppString +); +``` + +## Parameters + + `ixString` + [in] The index at which to start to search for the next value. + + `ppString` + [out] A pointer to a pointer to the returned string value. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataTables Interface](imetadatatables-interface.md) +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md new file mode 100644 index 0000000000000..62ae1472f017d --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: IMetaDataTables::GetStringHeapSize Method" +title: "IMetaDataTables::GetStringHeapSize Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables.GetStringHeapSize" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables::GetStringHeapSize" +helpviewer_keywords: + - "IMetaDataTables::GetStringHeapSize method [.NET Framework metadata]" + - "GetStringHeapSize method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables::GetStringHeapSize Method + +Gets the size, in bytes, of the string heap. + +## Syntax + +```cpp +HRESULT GetStringHeapSize ( + [out] ULONG *pcbStrings +); +``` + +## Parameters + + `pcbStrings` + [out] A pointer to the size, in bytes, of the string heap. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataTables Interface](imetadatatables-interface.md) +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-gettableindex-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md similarity index 86% rename from docs/framework/unmanaged-api/metadata/imetadatatables-gettableindex-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md index 351f239bcc087..6468233060ff1 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-gettableindex-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "GetTableIndex method [.NET Framework metadata]" - "IMetaDataTables::GetTableIndex method [.NET Framework metadata]" -ms.assetid: c6ec3800-e0d9-4387-afb8-ddc0b818114c topic_type: - "apiref" --- @@ -44,13 +43,13 @@ HRESULT GetTableIndex ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h **Library:** Used as a resource in MsCorEE.dll - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + **.NET versions:** Available since .NET Framework 1.0 ## See also diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md new file mode 100644 index 0000000000000..a86e1c52e1a87 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md @@ -0,0 +1,69 @@ +--- +description: "Learn more about: IMetaDataTables::GetTableInfo Method" +title: "IMetaDataTables::GetTableInfo Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables.GetTableInfo" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables::GetTableInfo" +helpviewer_keywords: + - "IMetaDataTables::GetTableInfo method [.NET Framework metadata]" + - "GetTableInfo method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables::GetTableInfo Method + +Gets the name, row size, number of rows, number of columns, and key column index of the specified table. + +## Syntax + +```cpp +HRESULT GetTableInfo ( + [in] ULONG ixTbl, + [out] ULONG *pcbRow, + [out] ULONG *pcRows, + [out] ULONG *pcCols, + [out] ULONG *piKey, + [out] const char **ppName +); +``` + +## Parameters + + `ixTbl` + [in] The identifier of the table whose properties to return. + + `pcbRow` + [out] A pointer to the size, in bytes, of a table row. + + `pcRows` + [out] A pointer to the number of rows in the table. + + `pcCols` + [out] A pointer to the number of columns in the table. + + `piKey` + [out] A pointer to the index of the key column, or -1 if the table has no key column. + + `ppName` + [out] A pointer to a pointer to the table name. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + +## See also + +- [IMetaDataTables Interface](imetadatatables-interface.md) +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md similarity index 83% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getuserstring-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md index b02ab86034ac8..d5d55f2771c6a 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "IMetaDataTables::GetUserString method [.NET Framework metadata]" - "GetUserString method, IMetaDataTables interface [.NET Framework metadata]" -ms.assetid: 35b8f0d6-9aba-4714-adb2-62020a38fb7e topic_type: - "apiref" --- @@ -45,13 +44,13 @@ HRESULT GetUserString ( ## Requirements -**Platforms:** See [System Requirements](../../get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h **Library:** Used as a resource in MsCorEE.dll -**.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] +**.NET versions:** Available since .NET Framework 2.0 ## See also diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md index 848073e9342cc..00ad04f818cd9 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataTables::GetUserStringHeapSize Method" title: "IMetaDataTables::GetUserStringHeapSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetUserStringHeapSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetUserStringHeapSize" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables::GetUserStringHeapSize method [.NET Framework metadata]" - "GetUserStringHeapSize method [.NET Framework metadata]" -ms.assetid: cba9e4d6-9461-4420-9614-96ff7039ec9c -topic_type: +topic_type: - "apiref" --- # IMetaDataTables::GetUserStringHeapSize Method -Gets the size, in bytes, of the user string heap. - -## Syntax - -```cpp -HRESULT GetUserStringHeapSize ( - [out] ULONG *pcbBlobs -); -``` - -## Parameters - - `pcbBlobs` - [out] A pointer to the size, in bytes, of the user string heap. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the size, in bytes, of the user string heap. + +## Syntax + +```cpp +HRESULT GetUserStringHeapSize ( + [out] ULONG *pcbBlobs +); +``` + +## Parameters + + `pcbBlobs` + [out] A pointer to the size, in bytes, of the user string heap. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md similarity index 68% rename from docs/framework/unmanaged-api/metadata/imetadatatables-interface.md rename to docs/core/unmanaged-api/metadata/imetadatatables-interface.md index 692af61bf2309..ff4bdf2e559d0 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md @@ -2,58 +2,57 @@ description: "Learn more about: IMetaDataTables Interface" title: "IMetaDataTables Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables interface [.NET Framework metadata]" -ms.assetid: 31272cce-506a-4f18-bcbf-01ee45e36356 -topic_type: +topic_type: - "apiref" --- # IMetaDataTables Interface -Provides methods for the storage and retrieval of metadata information in tables. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetBlob Method](imetadatatables-getblob-method.md)|Gets a pointer to the binary large object (BLOB) at the specified column index.| -|[GetBlobHeapSize Method](imetadatatables-getblobheapsize-method.md)|Gets the size, in bytes, of the BLOB heap.| -|[GetCodedTokenInfo Method](imetadatatables-getcodedtokeninfo-method.md)|Gets a pointer to an array of tokens associated with the specified row index.| -|[GetColumn Method](imetadatatables-getcolumn-method.md)|Gets a pointer to the values contained in the column at the specified column index, in the table at the specified table index.| -|[GetColumnInfo Method](imetadatatables-getcolumninfo-method.md)|Gets data about the specified column in the specified table.| -|[GetGuid Method](imetadatatables-getguid-method.md)|Gets a GUID from the row at the specified index.| -|[GetGuidHeapSize Method](imetadatatables-getguidheapsize-method.md)|Gets the size, in bytes, of the GUID heap.| -|[GetNextBlob Method](imetadatatables-getnextblob-method.md)|Gets the index of the next BLOB in the table.| -|[GetNextGuid Method](imetadatatables-getnextguid-method.md)|Gets the index of the next GUID value in the current table column.| -|[GetNextString Method](imetadatatables-getnextstring-method.md)|Gets the index of the next string in the current table column.| -|[GetNextUserString Method](imetadatatables-getnextuserstring-method.md)|Gets the index of the row that contains the next hard-coded string in the current table column.| -|[GetNumTables Method](imetadatatables-getnumtables-method.md)|Gets the number of tables in the scope of the current `IMetaDataTables` instance.| -|[GetRow Method](imetadatatables-getrow-method.md)|Gets the row at the specified row index, in the table at the specified table index.| -|[GetString Method](imetadatatables-getstring-method.md)|Gets the string at the specified index from the table column in the current reference scope.| -|[GetStringHeapSize Method](imetadatatables-getstringheapsize-method.md)|Gets the size, in bytes, of the string heap.| -|[GetTableIndex Method](imetadatatables-gettableindex-method.md)|Gets the index for the table referenced by the specified token.| -|[GetTableInfo Method](imetadatatables-gettableinfo-method.md)|Gets the name, row size, number of rows, number of columns, and key column index of the table at the specified table index.| -|[GetUserString Method](imetadatatables-getuserstring-method.md)|Gets the hard-coded string at the specified index in the string column in the current scope.| -|[GetUserStringHeapSize Method](imetadatatables-getuserstringheapsize-method.md)|Gets the size, in bytes, of the user string heap.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides methods for the storage and retrieval of metadata information in tables. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetBlob Method](imetadatatables-getblob-method.md)|Gets a pointer to the binary large object (BLOB) at the specified column index.| +|[GetBlobHeapSize Method](imetadatatables-getblobheapsize-method.md)|Gets the size, in bytes, of the BLOB heap.| +|[GetCodedTokenInfo Method](imetadatatables-getcodedtokeninfo-method.md)|Gets a pointer to an array of tokens associated with the specified row index.| +|[GetColumn Method](imetadatatables-getcolumn-method.md)|Gets a pointer to the values contained in the column at the specified column index, in the table at the specified table index.| +|[GetColumnInfo Method](imetadatatables-getcolumninfo-method.md)|Gets data about the specified column in the specified table.| +|[GetGuid Method](imetadatatables-getguid-method.md)|Gets a GUID from the row at the specified index.| +|[GetGuidHeapSize Method](imetadatatables-getguidheapsize-method.md)|Gets the size, in bytes, of the GUID heap.| +|[GetNextBlob Method](imetadatatables-getnextblob-method.md)|Gets the index of the next BLOB in the table.| +|[GetNextGuid Method](imetadatatables-getnextguid-method.md)|Gets the index of the next GUID value in the current table column.| +|[GetNextString Method](imetadatatables-getnextstring-method.md)|Gets the index of the next string in the current table column.| +|[GetNextUserString Method](imetadatatables-getnextuserstring-method.md)|Gets the index of the row that contains the next hard-coded string in the current table column.| +|[GetNumTables Method](imetadatatables-getnumtables-method.md)|Gets the number of tables in the scope of the current `IMetaDataTables` instance.| +|[GetRow Method](imetadatatables-getrow-method.md)|Gets the row at the specified row index, in the table at the specified table index.| +|[GetString Method](imetadatatables-getstring-method.md)|Gets the string at the specified index from the table column in the current reference scope.| +|[GetStringHeapSize Method](imetadatatables-getstringheapsize-method.md)|Gets the size, in bytes, of the string heap.| +|[GetTableIndex Method](imetadatatables-gettableindex-method.md)|Gets the index for the table referenced by the specified token.| +|[GetTableInfo Method](imetadatatables-gettableinfo-method.md)|Gets the name, row size, number of rows, number of columns, and key column index of the table at the specified table index.| +|[GetUserString Method](imetadatatables-getuserstring-method.md)|Gets the hard-coded string at the specified index in the string column in the current scope.| +|[GetUserStringHeapSize Method](imetadatatables-getuserstringheapsize-method.md)|Gets the size, in bytes, of the user string heap.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md new file mode 100644 index 0000000000000..7bb15d889f5ed --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IMetaDataTables2::GetMetaDataStorage Method" +title: "IMetaDataTables2::GetMetaDataStorage Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables2.GetMetaDataStorage" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables2::GetMetaDataStorage" +helpviewer_keywords: + - "GetMetaDataStorage method [.NET Framework metadata]" + - "IMetaDataTables2::GetMetaDataStorage method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables2::GetMetaDataStorage Method + +Gets the size and contents of the metadata stored in the specified section. + +## Syntax + +```cpp +HRESULT GetMetaDataStorage ( + [in, out] const void **ppvMd, + [out] ULONG *pcbMd +); +``` + +## Parameters + + `ppvMd` + [in, out] A pointer to a metadata section. + + `pcbMd` + [out] The size of the metadata stream. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) +- [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md new file mode 100644 index 0000000000000..3f51e8d38e534 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md @@ -0,0 +1,61 @@ +--- +description: "Learn more about: IMetaDataTables2::GetMetaDataStreamInfo Method" +title: "IMetaDataTables2::GetMetaDataStreamInfo Method" +ms.date: "03/30/2017" +api_name: + - "IMetaDataTables2.GetMetaDataStreamInfo" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IMetaDataTables2::GetMetaDataStreamInfo" +helpviewer_keywords: + - "GetMetaDataStreamInfo method [.NET Framework metadata]" + - "IMetaDataTables2::GetMetaDataStreamInfo method [.NET Framework metadata]" +topic_type: + - "apiref" +--- +# IMetaDataTables2::GetMetaDataStreamInfo Method + +Gets the name, size, and contents of the metadata stream at the specified index. + +## Syntax + +```cpp +HRESULT GetMetaDataStreamInfo ( + [in] ULONG ix, + [out] const char **ppchName, + [out] const void **ppv, + [out] ULONG *pcb +); +``` + +## Parameters + + `ix` + [in] The index of the requested metadata stream. + + `ppchName` + [out] A pointer to the name of the stream. + + `ppv` + [out] A pointer to the metadata stream. + + `pcb` + [out] The size, in bytes, of `ppv`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + +## See also + +- [IMetaDataTables2 Interface](imetadatatables2-interface.md) +- [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables2-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md similarity index 54% rename from docs/framework/unmanaged-api/metadata/imetadatatables2-interface.md rename to docs/core/unmanaged-api/metadata/imetadatatables2-interface.md index 1977ed9b2cd31..7c26a26f55813 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatatables2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md @@ -2,41 +2,40 @@ description: "Learn more about: IMetaDataTables2 Interface" title: "IMetaDataTables2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables2" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables2 interface [.NET Framework metadata]" -ms.assetid: c788bb7c-0212-4b6d-b840-22e8c8829028 -topic_type: +topic_type: - "apiref" --- # IMetaDataTables2 Interface -Extends [IMetaDataTables](imetadatatables-interface.md) to include methods for working with metadata streams. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetMetaDataStorage Method](imetadatatables2-getmetadatastorage-method.md)|Gets the size and contents of the metadata stored in the specified section.| -|[GetMetaDataStreamInfo Method](imetadatatables2-getmetadatastreaminfo-method.md)|Gets the name, size, and contents of the metadata stream at the specified index.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Extends [IMetaDataTables](imetadatatables-interface.md) to include methods for working with metadata streams. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetMetaDataStorage Method](imetadatatables2-getmetadatastorage-method.md)|Gets the size and contents of the metadata stored in the specified section.| +|[GetMetaDataStreamInfo Method](imetadatatables2-getmetadatastreaminfo-method.md)|Gets the name, size, and contents of the metadata stream at the specified index.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatavalidate-interface.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md similarity index 52% rename from docs/framework/unmanaged-api/metadata/imetadatavalidate-interface.md rename to docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md index 4a26e67c91c64..d4671c43691d2 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatavalidate-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md @@ -2,41 +2,40 @@ description: "Learn more about: IMetaDataValidate Interface" title: "IMetaDataValidate Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataValidate" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataValidate" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataValidate interface [.NET Framework metadata]" -ms.assetid: db98608a-e85c-4f50-9d7b-5f57a426ddb6 -topic_type: +topic_type: - "apiref" --- # IMetaDataValidate Interface -Provides methods to validate metadata signatures. - -## Methods - -|Method|Description| -|------------|-----------------| -|[ValidateMetaData Method](imetadatavalidate-validatemetadata-method.md)|Validates the metadata signatures of the objects in the current metadata scope.| -|[ValidatorInit Method](imetadatavalidate-validatorinit-method.md)|Sets a flag that specifies the type of the module in the current metadata scope, and registers the specified callback method for validation errors.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides methods to validate metadata signatures. + +## Methods + +|Method|Description| +|------------|-----------------| +|[ValidateMetaData Method](imetadatavalidate-validatemetadata-method.md)|Validates the metadata signatures of the objects in the current metadata scope.| +|[ValidatorInit Method](imetadatavalidate-validatorinit-method.md)|Sets a flag that specifies the type of the module in the current metadata scope, and registers the specified callback method for validation errors.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md rename to docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md index e6ceac4a8dc69..77a1b418f4ed0 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md @@ -2,41 +2,40 @@ description: "Learn more about: IMetaDataValidate::ValidateMetaData Method" title: "IMetaDataValidate::ValidateMetaData Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataValidate.ValidateMetaData" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataValidate::ValidateMetaData" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataValidate::ValidateMetaData method [.NET Framework metadata]" - "ValidateMetaData method [.NET Framework metadata]" -ms.assetid: e5ceed11-0f54-4097-8302-883284dddbc1 -topic_type: +topic_type: - "apiref" --- # IMetaDataValidate::ValidateMetaData Method -Validates the metadata signatures of the objects in the current metadata scope. - -## Syntax - -```cpp -HRESULT ValidateMetaData (); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Validates the metadata signatures of the objects in the current metadata scope. + +## Syntax + +```cpp +HRESULT ValidateMetaData (); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataValidate Interface](imetadatavalidate-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md similarity index 53% rename from docs/framework/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md rename to docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md index add825c292b33..9a570e24d36da 100644 --- a/docs/framework/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataValidate::ValidatorInit Method" title: "IMetaDataValidate::ValidatorInit Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataValidate.ValidatorInit" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataValidate::ValidatorInit" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataValidate::ValidatorInit method [.NET Framework metadata]" - "ValidatorInit method [.NET Framework metadata]" -ms.assetid: 6bafd75a-e2d0-4aea-aed1-074374d5dff6 -topic_type: +topic_type: - "apiref" --- # IMetaDataValidate::ValidatorInit Method -Sets a flag that specifies the type of the module in the current metadata scope, and registers the specified callback method for validation errors. - -## Syntax - -```cpp -HRESULT ValidatorInit ( - [in] DWORD dwModuleType, - [in] IUnknown *pUnk -); -``` - -## Parameters - - `dwModule` - [in] A value of the [CorValidatorModuleType](corvalidatormoduletype-enumeration.md) enumeration that specifies the type of the module in the current metadata scope. - - `pUnk` - [in] A pointer to an [IUnknown](/cpp/atl/iunknown) instance that serves as a function callback for validation errors. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Sets a flag that specifies the type of the module in the current metadata scope, and registers the specified callback method for validation errors. + +## Syntax + +```cpp +HRESULT ValidatorInit ( + [in] DWORD dwModuleType, + [in] IUnknown *pUnk +); +``` + +## Parameters + + `dwModule` + [in] A value of the [CorValidatorModuleType](corvalidatormoduletype-enumeration.md) enumeration that specifies the type of the module in the current metadata scope. + + `pUnk` + [in] A pointer to an [IUnknown](/cpp/atl/iunknown) instance that serves as a function callback for validation errors. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [IMetaDataValidate Interface](imetadatavalidate-interface.md) diff --git a/docs/core/unmanaged-api/metadata/index.md b/docs/core/unmanaged-api/metadata/index.md new file mode 100644 index 0000000000000..496371fa39e9b --- /dev/null +++ b/docs/core/unmanaged-api/metadata/index.md @@ -0,0 +1,28 @@ +--- +description: "Learn more about unmanaged APIs for .NET metadata" +title: ".NET metadata (unmanaged API reference)" +ms.date: "09/19/2023" +helpviewer_keywords: + - "unmanaged API reference [.NET], metadata" + - "native API reference [.NET], metadata" + - "metadata [.NET], using the unmanaged API" +--- +# .NET metadata (unmanaged API reference) + +The metadata API enables a client, such as a compiler, to generate or access a component's metadata without the types being loaded by the common language runtime (CLR). + +These APIs that can be used with both .NET Framework and .NET. + +## In this section + +[Metadata Interfaces](metadata-interfaces.md)\ +Describes the unmanaged interfaces that provide access to the metadata exposed by the .NET types, methods, fields, and so on. + +[Metadata Enumerations](metadata-enumerations.md)\ +Describes the unmanaged enumerations that the metadata API uses. + +[Metadata Structures](metadata-structures.md)\ +Describes the unmanaged structures that the metadata API uses. + +[Metadata Unions](metadata-unions.md)\ +Describes the unmanaged unions that the metadata API uses. diff --git a/docs/core/unmanaged-api/metadata/metadata-enumerations.md b/docs/core/unmanaged-api/metadata/metadata-enumerations.md new file mode 100644 index 0000000000000..2890909237acf --- /dev/null +++ b/docs/core/unmanaged-api/metadata/metadata-enumerations.md @@ -0,0 +1,158 @@ +--- +description: "Learn more about: Metadata Enumerations" +title: "Metadata Enumerations" +ms.date: "03/30/2017" +helpviewer_keywords: + - "enumerations [.NET Framework metadata]" + - "metadata enumerations [.NET Framework]" + - "unmanaged enumerations [.NET Framework], metadata" +--- +# Metadata enumerations + +This section describes the unmanaged enumerations that the metadata API uses. + +## In this section + + [AssemblyFlags Enumeration](assemblyflags-enumeration.md) + Contains values that describe the run-time features of an assembly. + + [AssemblyRefFlags Enumeration](assemblyrefflags-enumeration.md) + Contains values that describe the features of an assembly reference. + + [CeeSectionAttr Enumeration](ceesectionattr-enumeration.md) + Provides values that specify the attributes of a section for use by the [ICeeGen](iceegen-interface.md) interface. + + [CeeSectionRelocType Enumeration](ceesectionreloctype-enumeration.md) + Provides values to influence the type of `reloc` instruction emitted in a call to the [ICeeGen::AddSectionReloc](iceegen-addsectionreloc-method.md) method. + + [COINITICOR Enumeration](coiniticor-enumeration.md) + Specifies constants used by [CoInitializeCor](../../../framework/unmanaged-api/hosting/coinitializecor-function.md) when initializing the common language runtime. + + [COINITIEE Enumeration](coinitiee-enumeration.md) + Specifies constants used by [CoInitializeEE](../../../framework/unmanaged-api/hosting/coinitializeee-function.md) when initializing the common language runtime. + + [CorArgType Enumeration](corargtype-enumeration.md) + Contains values that describe the native type of a runtime handle. + + [CorAssemblyFlags Enumeration](corassemblyflags-enumeration.md) + Contains values that describe the metadata applied to an assembly compilation. + + [CorAttributeTargets Enumeration](corattributetargets-enumeration.md) + Specifies the application elements on which it is valid to apply an attribute. + + [CorCallingConvention Enumeration](corcallingconvention-enumeration.md) + Contains values that describe the types of calling conventions that are made in managed code. + + [CorCheckDuplicatesFor Enumeration](corcheckduplicatesfor-enumeration.md) + Contains values used during checks for duplications. + + [CorDeclSecurity Enumeration](cordeclsecurity-enumeration.md) + Contains values that describe the types of declarative security used by the common language runtime. + + CorElementType + Contains values that describe the underlying native type of a common language runtime . + + [CorErrorIfEmitOutOfOrder Enumeration](corerrorifemitoutoforder-enumeration.md) + Contains flag values that indicate the conditions under which an error message should be generated when metadata is emitted out of order. + + [CorEventAttr Enumeration](coreventattr-enumeration.md) + Contains values that describe the metadata of an event. + + [CorFieldAttr Enumeration](corfieldattr-enumeration.md) + Contains values that describe metadata about a field. + + [CorFileFlags Enumeration](corfileflags-enumeration.md) + Contains values that describe the type of file defined in a call to the [IMetaDataAssemblyEmit::DefineFile](imetadataassemblyemit-definefile-method.md) method. + + [CorFileMapping Enumeration](corfilemapping-enumeration.md) + Contains values that describe the type of file mapping that is returned from a call to the [IMetaDataInfo::GetFileMapping](imetadatainfo-getfilemapping-method.md) method. + + [CorGenericParamAttr Enumeration](corgenericparamattr-enumeration.md) + Contains values that describe the parameters for generic types, as used in calls to the [IMetaDataEmit2::DefineGenericParam](imetadataemit2-definegenericparam-method.md) method. + + [CorImportOptions Enumeration](corimportoptions-enumeration.md) + Contains flag values that control the behavior during importation of an assembly outside the current scope. + + [CorLinkerOptions Enumeration](corlinkeroptions-enumeration.md) + Specifies flags to select options for the metadata linker. + + [CorLocalRefPreservation Enumeration](corlocalrefpreservation-enumeration.md) + Contains flag values for the treatment of local references. + + [CorManifestResourceFlags Enumeration](cormanifestresourceflags-enumeration.md) + Contains values that describe the visibility of resources encoded in an assembly manifest. + + [CorMethodAttr Enumeration](cormethodattr-enumeration.md) + Contains values that describe metadata about a method. + + [CorMethodImpl Enumeration](cormethodimpl-enumeration.md) + Contains values that describe method implementation features. + + [CorMethodSemanticsAttr Enumeration](cormethodsemanticsattr-enumeration.md) + Contains values that describe the relationship between a method and an associated property or event. + + [CorNativeLinkFlags Enumeration](cornativelinkflags-enumeration.md) + Provides flag values used by the linker when linking native code. + + [CorNativeLinkType Enumeration](cornativelinktype-enumeration.md) + Provides values that indicate the type linked in native code. + + [CorNativeType Enumeration](cornativetype-enumeration.md) + Contains values that describe native unmanaged types. + + [CorNotificationForTokenMovement Enumeration](cornotificationfortokenmovement-enumeration.md) + Contains flag values that influence notifications upon token movement. + + [CorOpenFlags Enumeration](coropenflags-enumeration.md) + Contains flag values that control metadata behavior upon opening manifest files. + + [CorParamAttr Enumeration](corparamattr-enumeration.md) + Contains values that describe the metadata of a method parameter. + + [CorPEKind Enumeration](corpekind-enumeration.md) + Contains values that describe a portable executable file, as returned from a call to the [IMetaDataImport2::GetPEKind](imetadataimport2-getpekind-method.md) method. + + [CorPinvokeMap Enumeration](corpinvokemap-enumeration.md) + Contains values that describe features of a PInvoke call. + + [CorPropertyAttr Enumeration](corpropertyattr-enumeration.md) + Contains values that describe the metadata of a property. + + [CorRefToDefCheck Enumeration](correftodefcheck-enumeration.md) + Specifies flags to control which referenced items are converted to their definitions in order to optimize the code. + + [CorRegFlags Enumeration](corregflags-enumeration.md) + Provides flag values used for registration when installing a module or composite. + + [CorSaveSize Enumeration](corsavesize-enumeration.md) + Contains values indicating the level of precision required when querying for the size of a save operation. + + [CorSerializationType Enumeration](corserializationtype-enumeration.md) + Contains values that describe how an object is serialized by the common language runtime. These values generally correspond to CorElementType values. + + [CorSetENC Enumeration](corsetenc-enumeration.md) + Contains values used to influence behavior during the generation of metadata. + + [CorThreadSafetyOptions Enumeration](corthreadsafetyoptions-enumeration.md) + Specifies flags to select options for thread safety. + + [CorTokenType Enumeration](cortokentype-enumeration.md) + Contains values that indicate the kind of object that a metadata token references. + + [CorTypeAttr Enumeration](cortypeattr-enumeration.md) + Contains values that indicate type metadata. + + [CorUnmanagedCallingConvention Enumeration](corunmanagedcallingconvention-enumeration.md) + Contains values that describe unmanaged calling conventions. + + [CorValidatorModuleType Enumeration](corvalidatormoduletype-enumeration.md) + Provides values used by the [IMetaDataValidate](imetadatavalidate-interface.md) interface to specify the type of the module (PE file vs. .obj file). + + [COUNINITIEE Enumeration](couninitiee-enumeration.md) + Specifies constants used by [CoUninitializeEE](../../../framework/unmanaged-api/hosting/couninitializeee-function.md) when initializing the common language runtime. + +## Related sections + +- [Metadata Interfaces](metadata-interfaces.md) +- [Metadata Structures](metadata-structures.md) +- [Metadata Unions](metadata-unions.md) diff --git a/docs/framework/unmanaged-api/metadata/metadata-interfaces.md b/docs/core/unmanaged-api/metadata/metadata-interfaces.md similarity index 50% rename from docs/framework/unmanaged-api/metadata/metadata-interfaces.md rename to docs/core/unmanaged-api/metadata/metadata-interfaces.md index bb386257141f1..ca64f7eb4dd1b 100644 --- a/docs/framework/unmanaged-api/metadata/metadata-interfaces.md +++ b/docs/core/unmanaged-api/metadata/metadata-interfaces.md @@ -2,78 +2,73 @@ description: "Learn more about: Metadata Interfaces" title: "Metadata Interfaces" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "unmanaged interfaces [.NET Framework], metadata" - "metadata interfaces [.NET Framework]" - "interfaces (.NET Framework metadata]" -ms.assetid: f5cdac93-a28c-48ef-8a19-5773376e9e7c --- -# Metadata Interfaces - -This section describes the unmanaged interfaces that provide access to the metadata exposed by the .NET Framework types, methods, fields, and so on. - -## In This Section - - [ICeeGen Interface](iceegen-interface.md) - Provides methods for dynamic code compilation. - - [IHostFilter Interface](ihostfilter-interface.md) - Provides a method for the run-time host to mark metadata tokens for processing. - - [IMapToken Interface](imaptoken-interface.md) - Provides mapping capabilities between imported and emitted metadata signatures. - - [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) - Provides methods that support the self-description model used by the common language runtime (CLR) to resolve and consume resources. - - [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) - Provides methods to access and examine the contents of an assembly manifest. - - [IMetaDataConverter Interface](imetadataconverter-interface.md) - Provides methods to map type libraries to their metadata signatures, and to convert from one to the other. - - [IMetaDataDispenser Interface](imetadatadispenser-interface.md) - `IMetaDataDispenser` is obsolete. Use `IMetaDataDispenserEx` instead. - - [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) - Provides methods that map areas of memory for creating or modifying metadata. - - [IMetaDataEmit Interface](imetadataemit-interface.md) - Provides methods to create, modify and store metadata about the assembly in the currently defined scope. - - [IMetaDataEmit2 Interface](imetadataemit2-interface.md) - Provides methods for defining and modifying the metadata signatures of methods and constructors with parameters of type . - - [IMetaDataError Interface](imetadataerror-interface.md) - Provides a callback mechanism for reporting errors during the resolution of the metadata signature for an assembly. - - [IMetaDataFilter Interface](imetadatafilter-interface.md) - Provides methods for marking and filtering metadata tokens to avoid repeating actions that have already been taken. - - [IMetaDataImport Interface](imetadataimport-interface.md) - Provides methods for importing and manipulating types from other assemblies. - - [IMetaDataImport2 Interface](imetadataimport2-interface.md) - Extends `IMetaDataImport` to provide the capability of working with generic types. - - [IMetaDataInfo Interface](imetadatainfo-interface.md) - Provides a method that gets information about the mapping of metadata from an on-disk file into memory. - - [IMetaDataTables Interface](imetadatatables-interface.md) - Provides methods for the storage and retrieval of metadata information in tables. - - [IMetaDataTables2 Interface](imetadatatables2-interface.md) - Extends `IMetaDataTables` to include methods for working with metadata streams. - - [IMetaDataValidate Interface](imetadatavalidate-interface.md) - Provides methods to use for validation of metadata signatures. - -## Related Sections - - [Metadata Global Static Functions](metadata-global-static-functions.md) - - [Metadata Enumerations](metadata-enumerations.md) - - [Metadata Structures](metadata-structures.md) - - [Metadata Unions](metadata-unions.md) +# Metadata interfaces + +This section describes the unmanaged interfaces that provide access to the metadata exposed by the .NET Framework types, methods, fields, and so on. + +## In this section + + [ICeeGen Interface](iceegen-interface.md) + Provides methods for dynamic code compilation. + + [IHostFilter Interface](ihostfilter-interface.md) + Provides a method for the run-time host to mark metadata tokens for processing. + + [IMapToken Interface](imaptoken-interface.md) + Provides mapping capabilities between imported and emitted metadata signatures. + + [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) + Provides methods that support the self-description model used by the common language runtime (CLR) to resolve and consume resources. + + [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) + Provides methods to access and examine the contents of an assembly manifest. + + [IMetaDataConverter Interface](imetadataconverter-interface.md) + Provides methods to map type libraries to their metadata signatures, and to convert from one to the other. + + [IMetaDataDispenser Interface](imetadatadispenser-interface.md) + `IMetaDataDispenser` is obsolete. Use `IMetaDataDispenserEx` instead. + + [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) + Provides methods that map areas of memory for creating or modifying metadata. + + [IMetaDataEmit Interface](imetadataemit-interface.md) + Provides methods to create, modify and store metadata about the assembly in the currently defined scope. + + [IMetaDataEmit2 Interface](imetadataemit2-interface.md) + Provides methods for defining and modifying the metadata signatures of methods and constructors with parameters of type . + + [IMetaDataError Interface](imetadataerror-interface.md) + Provides a callback mechanism for reporting errors during the resolution of the metadata signature for an assembly. + + [IMetaDataFilter Interface](imetadatafilter-interface.md) + Provides methods for marking and filtering metadata tokens to avoid repeating actions that have already been taken. + + [IMetaDataImport Interface](imetadataimport-interface.md) + Provides methods for importing and manipulating types from other assemblies. + + [IMetaDataImport2 Interface](imetadataimport2-interface.md) + Extends `IMetaDataImport` to provide the capability of working with generic types. + + [IMetaDataInfo Interface](imetadatainfo-interface.md) + Provides a method that gets information about the mapping of metadata from an on-disk file into memory. + + [IMetaDataTables Interface](imetadatatables-interface.md) + Provides methods for the storage and retrieval of metadata information in tables. + + [IMetaDataTables2 Interface](imetadatatables2-interface.md) + Extends `IMetaDataTables` to include methods for working with metadata streams. + + [IMetaDataValidate Interface](imetadatavalidate-interface.md) + Provides methods to use for validation of metadata signatures. + +## Related sections + +- [Metadata Enumerations](metadata-enumerations.md) +- [Metadata Structures](metadata-structures.md) +- [Metadata Unions](metadata-unions.md) diff --git a/docs/core/unmanaged-api/metadata/metadata-structures.md b/docs/core/unmanaged-api/metadata/metadata-structures.md new file mode 100644 index 0000000000000..269ab930bce92 --- /dev/null +++ b/docs/core/unmanaged-api/metadata/metadata-structures.md @@ -0,0 +1,35 @@ +--- +description: "Learn more about: Metadata Structures" +title: "Metadata Structures" +ms.date: "03/30/2017" +helpviewer_keywords: + - "structures [.NET Framework metadata]" + - "unmanaged structures [.NET Framework], metadata" + - "metadata structures [.NET Framework]" +--- +# Metadata structures + +This section describes the unmanaged structures that the metadata API uses. + +## In this section + + ASSEMBLYMETADATA + Stores assembly metadata for later use. + + [COR_FIELD_OFFSET Structure](cor-field-offset-structure.md) + Stores the offset, within a class, of the specified field. + + [COR_NATIVE_LINK Structure](cor-native-link-structure.md) + Contains information that is used to link native code. + + [CVStruct Structure](cvstruct-structure.md) + Contains information that is used when installing a module or a composite image. + + [OSINFO Structure](osinfo-structure.md) + Contains information about the operating system. + +## Related sections + +- [Metadata Interfaces](metadata-interfaces.md) +- [Metadata Enumerations](metadata-enumerations.md) +- [Metadata Unions](metadata-unions.md) diff --git a/docs/core/unmanaged-api/metadata/metadata-unions.md b/docs/core/unmanaged-api/metadata/metadata-unions.md new file mode 100644 index 0000000000000..b15f7a6ddf03e --- /dev/null +++ b/docs/core/unmanaged-api/metadata/metadata-unions.md @@ -0,0 +1,23 @@ +--- +description: "Learn more about: Metadata Unions" +title: "Metadata Unions" +ms.date: "03/30/2017" +helpviewer_keywords: + - "unmanaged unions [.NET Framework], metadata" + - "unions [.NET Framework metadata]" + - "metadata unions [.NET Framework]" +--- +# Metadata unions + +This section describes the unmanaged unions that the metadata API uses. + +## In this section + + [CeeSectionRelocExtra Union](ceesectionrelocextra-union.md) + Represents an address offset that is used by the [ICeeGen](iceegen-interface.md) interface to relocate a section + +## Related sections + +- [Metadata Interfaces](metadata-interfaces.md) +- [Metadata Enumerations](metadata-enumerations.md) +- [Metadata Structures](metadata-structures.md) diff --git a/docs/framework/unmanaged-api/metadata/osinfo-structure.md b/docs/core/unmanaged-api/metadata/osinfo-structure.md similarity index 62% rename from docs/framework/unmanaged-api/metadata/osinfo-structure.md rename to docs/core/unmanaged-api/metadata/osinfo-structure.md index 540240c8cfb90..736ce034aa7c5 100644 --- a/docs/framework/unmanaged-api/metadata/osinfo-structure.md +++ b/docs/core/unmanaged-api/metadata/osinfo-structure.md @@ -2,56 +2,55 @@ description: "Learn more about: OSINFO Structure" title: "OSINFO Structure" ms.date: "03/30/2017" -api_name: +api_name: - "OSINFO" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "OSINFO" -helpviewer_keywords: +helpviewer_keywords: - "OSINFO structure [.NET Framework metadata]" -ms.assetid: fac7b480-7adb-4450-a5e9-690fed81ffae -topic_type: +topic_type: - "apiref" --- # OSINFO Structure -Contains details about the operating system for an assembly or module. - -## Syntax - -```cpp -typedef struct { - DWORD dwOSPlatformId; +Contains details about the operating system for an assembly or module. + +## Syntax + +```cpp +typedef struct { + DWORD dwOSPlatformId; DWORD dwOSMajorVersion; DWORD dwOSMinorVersion; -} OSINFO; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`dwOSPlatformId`|One of the identifier values defined by the Microsoft Windows platform function `GetVersionEx`. The following values are supported:

- VER_PLATFORM_WIN32s, or 0x0000, to specify Microsoft Windows 3.1.
- VER_PLATFORM_WIN32_WINDOWS, or 0x0001, to specify Windows 95, Windows 98, or operating systems descended from them.
- VER_PLATFORM_WIN32_NT, or 0x0002, to specify Windows NT or operating systems descended from it.| -|`dwOSMajorVersion`|The operating system major version, or a NULL value to indicate any version.| -|`dwOSMinorVersion`|The operating system minor version, or a NULL value to indicate any version.| - -## Remarks - - `OSINFO` is based on the `OSVERSIONINFOEX` structure that is used in calls to the Microsoft Windows platform function `GetVersionEx`. This structure is used by the ASSEMBLYMETADATA structure to indicate its operating system support. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +} OSINFO; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`dwOSPlatformId`|One of the identifier values defined by the Microsoft Windows platform function `GetVersionEx`. The following values are supported:

- VER_PLATFORM_WIN32s, or 0x0000, to specify Microsoft Windows 3.1.
- VER_PLATFORM_WIN32_WINDOWS, or 0x0001, to specify Windows 95, Windows 98, or operating systems descended from them.
- VER_PLATFORM_WIN32_NT, or 0x0002, to specify Windows NT or operating systems descended from it.| +|`dwOSMajorVersion`|The operating system major version, or a NULL value to indicate any version.| +|`dwOSMinorVersion`|The operating system minor version, or a NULL value to indicate any version.| + +## Remarks + + `OSINFO` is based on the `OSVERSIONINFOEX` structure that is used in calls to the Microsoft Windows platform function `GetVersionEx`. This structure is used by the ASSEMBLYMETADATA structure to indicate its operating system support. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Used as a resource in MsCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Metadata Structures](metadata-structures.md) diff --git a/docs/core/unmanaged-api/profiling/cor-prf-rejit-flags-enumeration.md b/docs/core/unmanaged-api/profiling/cor-prf-rejit-flags-enumeration.md index 9e79fbb11c863..beab4ea15dec0 100644 --- a/docs/core/unmanaged-api/profiling/cor-prf-rejit-flags-enumeration.md +++ b/docs/core/unmanaged-api/profiling/cor-prf-rejit-flags-enumeration.md @@ -46,4 +46,4 @@ typedef enum **Library:** CorGuids.lib - **.NET Framework Versions:** Available since .NET Core 3.0 + **.NET versions:** Available since .NET Core 3.0 diff --git a/docs/core/unmanaged-api/profiling/icorprofilerinfo9-getiltonativemapping3-method.md b/docs/core/unmanaged-api/profiling/icorprofilerinfo9-getiltonativemapping3-method.md index c90a3eeb9f785..5f5e467e5a73f 100644 --- a/docs/core/unmanaged-api/profiling/icorprofilerinfo9-getiltonativemapping3-method.md +++ b/docs/core/unmanaged-api/profiling/icorprofilerinfo9-getiltonativemapping3-method.md @@ -52,7 +52,7 @@ When tiered compilation is enabled, a method may have more than one native code **Library:** CorGuids.lib -**.NET Framework Versions:** Available since .NET Core 2.1 +**.NET versions:** Available since .NET Core 2.1 ## See also diff --git a/docs/framework/configure-apps/file-schema/runtime/alwaysflowimpersonationpolicy-element.md b/docs/framework/configure-apps/file-schema/runtime/alwaysflowimpersonationpolicy-element.md index 711af4e018fa0..057e3169aec62 100644 --- a/docs/framework/configure-apps/file-schema/runtime/alwaysflowimpersonationpolicy-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/alwaysflowimpersonationpolicy-element.md @@ -2,111 +2,111 @@ description: "Learn more about: Element" title: " Element" ms.date: "03/30/2017" -f1_keywords: +f1_keywords: - "http://schemas.microsoft.com/.NetConfiguration/v2.0#configuration/runtime/alwaysFlowImpersonationPolicy" - "http://schemas.microsoft.com/.NetConfiguration/v2.0#alwaysFlowImpersonationPolicy" -helpviewer_keywords: +helpviewer_keywords: - "alwaysFlowImpersonationPolicy element" - " element" ms.assetid: ee622801-9e46-470b-85ab-88c4b1dd2ee1 --- # \ Element -Specifies that the Windows identity always flows across asynchronous points, regardless of how impersonation was performed. - +Specifies that the Windows identity always flows across asynchronous points, regardless of how impersonation was performed. + [**\**](../configuration-element.md)\   [**\**](runtime-element.md)\     **\** - -## Syntax - -```xml + +## Syntax + +```xml -``` - -## Attributes and Elements - - The following sections describe attributes, child elements, and parent elements. - -### Attributes - -|Attribute|Description| -|---------------|-----------------| -|`enabled`|Required attribute.

Indicates whether the Windows identity flows across asynchronous points.| - -## enabled Attribute - -|Value|Description| -|-----------|-----------------| -|`false`|The Windows identity does not flow across asynchronous points, unless the impersonation is performed through managed methods such as . This is the default.| -|`true`|The Windows identity always flows across asynchronous points, regardless of how impersonation was performed.| - -### Child Elements - - None. - -### Parent Elements - -|Element|Description| -|-------------|-----------------| -|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| -|`runtime`|Contains information about assembly binding and garbage collection.| - -## Remarks - - In the .NET Framework versions 1.0 and 1.1, the Windows identity does not flow across asynchronous points. In .NET Framework version 2.0, there is an object that contains information about the currently executing thread, and flows it across asynchronous points within an application domain. The also flows as part of the information that flows across the asynchronous points, provided the impersonation was achieved using managed methods such as and not through other means such as platform invoke to native methods. This element is used to specify that the Windows identity does flow across asynchronous points, regardless of how the impersonation was achieved. - - You can alter this default behavior in two other ways: - -1. In managed code on a per-thread basis. - - You can suppress the flow on a per-thread basis by modifying the and settings by using the , , or method. - -2. In the call to the unmanaged hosting interface to load the common language runtime (CLR). - - If an unmanaged hosting interface (instead of a simple managed executable) is used to load the CLR, you can specify a special flag in the call to the [CorBindToRuntimeEx Function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md) function. To enable the compatibility mode for the entire process, set the `flags` parameter for [CorBindToRuntimeEx Function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md) to `STARTUP_ALWAYSFLOW_IMPERSONATION`. - -## Configuration File - - In a .NET Framework application, this element can be used only in the application configuration file. - - For an ASP.NET application, the impersonation flow can be configured in the aspnet.config file found in the \\Microsoft.NET\Framework\vx.x.xxxx directory. - - ASP.NET by default disables the impersonation flow in the aspnet.config file by using the following configuration settings: - + enabled="true|false"/> +``` + +## Attributes and Elements + + The following sections describe attributes, child elements, and parent elements. + +### Attributes + +|Attribute|Description| +|---------------|-----------------| +|`enabled`|Required attribute.

Indicates whether the Windows identity flows across asynchronous points.| + +## enabled Attribute + +|Value|Description| +|-----------|-----------------| +|`false`|The Windows identity does not flow across asynchronous points, unless the impersonation is performed through managed methods such as . This is the default.| +|`true`|The Windows identity always flows across asynchronous points, regardless of how impersonation was performed.| + +### Child Elements + + None. + +### Parent Elements + +|Element|Description| +|-------------|-----------------| +|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| +|`runtime`|Contains information about assembly binding and garbage collection.| + +## Remarks + + In the .NET Framework versions 1.0 and 1.1, the Windows identity does not flow across asynchronous points. In .NET Framework version 2.0, there is an object that contains information about the currently executing thread, and flows it across asynchronous points within an application domain. The also flows as part of the information that flows across the asynchronous points, provided the impersonation was achieved using managed methods such as and not through other means such as platform invoke to native methods. This element is used to specify that the Windows identity does flow across asynchronous points, regardless of how the impersonation was achieved. + + You can alter this default behavior in two other ways: + +1. In managed code on a per-thread basis. + + You can suppress the flow on a per-thread basis by modifying the and settings by using the , , or method. + +2. In the call to the unmanaged hosting interface to load the common language runtime (CLR). + + If an unmanaged hosting interface (instead of a simple managed executable) is used to load the CLR, you can specify a special flag in the call to the [CorBindToRuntimeEx Function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md) function. To enable the compatibility mode for the entire process, set the `flags` parameter for [CorBindToRuntimeEx Function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md) to `STARTUP_ALWAYSFLOW_IMPERSONATION`. + +## Configuration File + + In a .NET Framework application, this element can be used only in the application configuration file. + + For an ASP.NET application, the impersonation flow can be configured in the aspnet.config file found in the \\Microsoft.NET\Framework\vx.x.xxxx directory. + + ASP.NET by default disables the impersonation flow in the aspnet.config file by using the following configuration settings: + ```xml - - - - - - -``` - - In ASP.NET, if you want to allow the flow of impersonation instead, you must explicitly use the following configuration settings: - -```xml - - - - - - -``` - -## Example - - The following example shows how to specify that the Windows identity flows across asynchronous points, even when the impersonation is achieved through means other than managed methods. - -```xml - - - - - -``` - + + + + + + +``` + + In ASP.NET, if you want to allow the flow of impersonation instead, you must explicitly use the following configuration settings: + +```xml + + + + + + +``` + +## Example + + The following example shows how to specify that the Windows identity flows across asynchronous points, even when the impersonation is achieved through means other than managed methods. + +```xml + + + + + +``` + ## See also - [Configure apps by using configuration files](../../index.md) diff --git a/docs/framework/configure-apps/file-schema/runtime/appdomainmanagerassembly-element.md b/docs/framework/configure-apps/file-schema/runtime/appdomainmanagerassembly-element.md index 249c4d3f2bd26..efc56780ae140 100644 --- a/docs/framework/configure-apps/file-schema/runtime/appdomainmanagerassembly-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/appdomainmanagerassembly-element.md @@ -2,75 +2,75 @@ description: "Learn more about: Element" title: " Element" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - " element" - "appDomainManagerAssembly element" ms.assetid: c7c56e39-a700-44f5-b94e-411bfce339d9 --- # \ Element -Specifies the assembly that provides the application domain manager for the default application domain in the process. - +Specifies the assembly that provides the application domain manager for the default application domain in the process. + [**\**](../configuration-element.md)\   [**\**](runtime-element.md)\ -    **\** - -## Syntax - -```xml +    **\** + +## Syntax + +```xml -``` - -## Attributes and Elements - - The following sections describe attributes, child elements, and parent elements. - -### Attributes - -|Attribute|Description| -|---------------|-----------------| -|`value`|Required attribute. Specifies the display name of the assembly that provides the application domain manager for the default application domain in the process.| - -### Child Elements - - None. - -### Parent Elements - -|Element|Description| -|-------------|-----------------| -|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| -|`runtime`|Contains information about assembly binding and garbage collection.| - -## Remarks - - To specify the type of the application domain manager, you must specify both this element and the [\](appdomainmanagertype-element.md) element. If either of these elements is not specified, the other is ignored. - - When the default application domain is loaded, is thrown if the specified assembly does not exist or if the assembly does not contain the type specified by the [\](appdomainmanagertype-element.md) element; and the process fails to start. If the assembly is found but the version information does not match, a is thrown. - - When you specify the application domain manager type for the default application domain, other application domains created from the default application domain inherit the application domain manager type. Use the and properties to specify a different application domain manager type for a new application domain. - - Specifying the application domain manager type requires the application to have full trust. (For example, an application running on the desktop has full trust.) If the application does not have full trust, a is thrown. - - For the format of the assembly display name, see the property. - - This configuration element is available only in the .NET Framework 4 and later. - -## Example - - The following example shows how to specify that the application domain manager for the default application domain of a process is the `MyMgr` type in the `AdMgrExample` assembly. - -```xml - - - + value="assembly display name" /> +``` + +## Attributes and Elements + + The following sections describe attributes, child elements, and parent elements. + +### Attributes + +|Attribute|Description| +|---------------|-----------------| +|`value`|Required attribute. Specifies the display name of the assembly that provides the application domain manager for the default application domain in the process.| + +### Child Elements + + None. + +### Parent Elements + +|Element|Description| +|-------------|-----------------| +|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| +|`runtime`|Contains information about assembly binding and garbage collection.| + +## Remarks + + To specify the type of the application domain manager, you must specify both this element and the [\](appdomainmanagertype-element.md) element. If either of these elements is not specified, the other is ignored. + + When the default application domain is loaded, is thrown if the specified assembly does not exist or if the assembly does not contain the type specified by the [\](appdomainmanagertype-element.md) element; and the process fails to start. If the assembly is found but the version information does not match, a is thrown. + + When you specify the application domain manager type for the default application domain, other application domains created from the default application domain inherit the application domain manager type. Use the and properties to specify a different application domain manager type for a new application domain. + + Specifying the application domain manager type requires the application to have full trust. (For example, an application running on the desktop has full trust.) If the application does not have full trust, a is thrown. + + For the format of the assembly display name, see the property. + + This configuration element is available only in the .NET Framework 4 and later. + +## Example + + The following example shows how to specify that the application domain manager for the default application domain of a process is the `MyMgr` type in the `AdMgrExample` assembly. + +```xml + + + - - -``` - + value="AdMgrExample, Version=1.0.0.0, Culture=neutral, PublicKeyToken=6856bccf150f00b3" /> + + +``` + ## See also - [Configure apps by using configuration files](../../index.md) diff --git a/docs/framework/configure-apps/file-schema/runtime/appdomainmanagertype-element.md b/docs/framework/configure-apps/file-schema/runtime/appdomainmanagertype-element.md index bcf5f8c97823c..83cd0f284a55e 100644 --- a/docs/framework/configure-apps/file-schema/runtime/appdomainmanagertype-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/appdomainmanagertype-element.md @@ -2,75 +2,75 @@ description: "Learn more about: Element" title: " Element" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "appDomainManagerType element" - " element" ms.assetid: ae8d5a7e-e7f7-47f7-98d9-455cc243a322 --- # \ Element -Specifies the type that serves as the application domain manager for the default application domain. - +Specifies the type that serves as the application domain manager for the default application domain. + [**\**](../configuration-element.md)\   [**\**](runtime-element.md)\ -    **\** - -## Syntax - -```xml +    **\** + +## Syntax + +```xml -``` - -## Attributes and Elements - - The following sections describe attributes, child elements, and parent elements. - -### Attributes - -|Attribute|Description| -|---------------|-----------------| -|`value`|Required attribute. Specifies the name of the type, including the namespace, that serves as the application domain manager for the default application domain in the process.| - -### Child Elements - - None. - -### Parent Elements - -|Element|Description| -|-------------|-----------------| -|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| -|`runtime`|Contains information about assembly binding and garbage collection.| - -## Remarks - - To specify the type of the application domain manager, you must specify both this element and the [\](appdomainmanagerassembly-element.md) element. If either of these elements is not specified, the other is ignored. - - When the default application domain is loaded, is thrown if the specified type does not exist in the assembly that is specified by the [\](appdomainmanagerassembly-element.md) element; and the process fails to start. - - When you specify the application domain manager type for the default application domain, other application domains created from the default application domain inherit the application domain manager type. Use the and properties to specify a different application domain manager type for a new application domain. - - Specifying the application domain manager type requires the application to have full trust. (For example, an application running on the desktop has full trust.) If the application does not have full trust, a is thrown. - - The format of the type and namespace is the same format that is used for the property. - - This configuration element is available only in the .NET Framework 4 and later. - -## Example - - The following example shows how to specify that the application domain manager for the default application domain of a process is the `MyMgr` type in the `AdMgrExample` assembly. - -```xml - - - + value="type name" /> +``` + +## Attributes and Elements + + The following sections describe attributes, child elements, and parent elements. + +### Attributes + +|Attribute|Description| +|---------------|-----------------| +|`value`|Required attribute. Specifies the name of the type, including the namespace, that serves as the application domain manager for the default application domain in the process.| + +### Child Elements + + None. + +### Parent Elements + +|Element|Description| +|-------------|-----------------| +|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| +|`runtime`|Contains information about assembly binding and garbage collection.| + +## Remarks + + To specify the type of the application domain manager, you must specify both this element and the [\](appdomainmanagerassembly-element.md) element. If either of these elements is not specified, the other is ignored. + + When the default application domain is loaded, is thrown if the specified type does not exist in the assembly that is specified by the [\](appdomainmanagerassembly-element.md) element; and the process fails to start. + + When you specify the application domain manager type for the default application domain, other application domains created from the default application domain inherit the application domain manager type. Use the and properties to specify a different application domain manager type for a new application domain. + + Specifying the application domain manager type requires the application to have full trust. (For example, an application running on the desktop has full trust.) If the application does not have full trust, a is thrown. + + The format of the type and namespace is the same format that is used for the property. + + This configuration element is available only in the .NET Framework 4 and later. + +## Example + + The following example shows how to specify that the application domain manager for the default application domain of a process is the `MyMgr` type in the `AdMgrExample` assembly. + +```xml + + + - - -``` - + value="AdMgrExample, Version=1.0.0.0, Culture=neutral, PublicKeyToken=6856bccf150f00b3" /> + + +``` + ## See also - [Configure apps by using configuration files](../../index.md) diff --git a/docs/framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md b/docs/framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md index 4c811bca4251b..a05e5fb167529 100644 --- a/docs/framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md @@ -2,74 +2,74 @@ description: "Learn more about: Element" title: " Element" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "appDomainResourceMonitoring element" - " element" ms.assetid: 02119ab6-1e91-448e-97ad-e7b2e5c4bbbd --- # \ Element -Instructs the runtime to collect statistics on all application domains in the process for the life of the process. - +Instructs the runtime to collect statistics on all application domains in the process for the life of the process. + [**\**](../configuration-element.md)\   [**\**](runtime-element.md)\ -    **\** - -## Syntax - -```xml +    **\** + +## Syntax + +```xml -``` - -## Attributes and Elements - - The following sections describe attributes, child elements, and parent elements. - -### Attributes - -|Attribute|Description| -|---------------|-----------------| -|`enabled`|Required attribute.

Specifies whether the runtime collects statistics for application domain resource monitoring.| - -## enabled Attribute - -|Value|Description| -|-----------|-----------------| -|`true`|Statistics for application domain resource monitoring are collected.| -|`false`|Statistics for application domain resource monitoring are not collected.| - -### Child Elements - - None. - -### Parent Elements - -|Element|Description| -|-------------|-----------------| -|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| -|`runtime`|Contains information about assembly binding and garbage collection.| - -## Remarks - - Application domain resource monitoring is available through the managed application domain class, the hosting [ICLRAppDomainResourceMonitor](../../../unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) interface, and event tracing for Windows (ETW). When monitoring is enabled, statistics are collected for all application domains in the process for the life of the process. - - To enable monitoring from managed code, use the property. - - This configuration element is available only in the .NET Framework 4 and later. - -## Example - - The following example shows how to enable application domain resource monitoring. - -```xml - - - - - -``` - + enabled="true|false"/> +``` + +## Attributes and Elements + + The following sections describe attributes, child elements, and parent elements. + +### Attributes + +|Attribute|Description| +|---------------|-----------------| +|`enabled`|Required attribute.

Specifies whether the runtime collects statistics for application domain resource monitoring.| + +## enabled Attribute + +|Value|Description| +|-----------|-----------------| +|`true`|Statistics for application domain resource monitoring are collected.| +|`false`|Statistics for application domain resource monitoring are not collected.| + +### Child Elements + + None. + +### Parent Elements + +|Element|Description| +|-------------|-----------------| +|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| +|`runtime`|Contains information about assembly binding and garbage collection.| + +## Remarks + + Application domain resource monitoring is available through the managed application domain class, the hosting [ICLRAppDomainResourceMonitor](../../../unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) interface, and event tracing for Windows (ETW). When monitoring is enabled, statistics are collected for all application domains in the process for the life of the process. + + To enable monitoring from managed code, use the property. + + This configuration element is available only in the .NET Framework 4 and later. + +## Example + + The following example shows how to enable application domain resource monitoring. + +```xml + + + + + +``` + ## See also - [Configure apps by using configuration files](../../index.md) diff --git a/docs/framework/configure-apps/file-schema/runtime/disablecommitthreadstack-element.md b/docs/framework/configure-apps/file-schema/runtime/disablecommitthreadstack-element.md index 452cdadcb39b1..50b7680e5e8c5 100644 --- a/docs/framework/configure-apps/file-schema/runtime/disablecommitthreadstack-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/disablecommitthreadstack-element.md @@ -2,75 +2,75 @@ description: "Learn more about: Element" title: " Element" ms.date: "03/30/2017" -f1_keywords: +f1_keywords: - "http://schemas.microsoft.com/.NetConfiguration/v2.0#configuration/runtime/disableCommitThreadStack" - "http://schemas.microsoft.com/.NetConfiguration/v2.0#disableCommitThreadStack" -helpviewer_keywords: +helpviewer_keywords: - " element" - "disableCommitThreadStack element" ms.assetid: 3559d46a-7640-4c72-9a11-7e980768929e --- # \ Element -Specifies whether the full thread stack is committed when a thread is started. - +Specifies whether the full thread stack is committed when a thread is started. + [**\**](../configuration-element.md)\   [**\**](runtime-element.md)\ -    **\** - -## Syntax - -```xml - -``` - -## Attributes and Elements - - The following sections describe attributes, child elements, and parent elements. - -### Attributes - -|Attribute|Description| -|---------------|-----------------| -|enabled|Required attribute.

Specifies whether committing the full thread stack on thread startup (the default behavior) is disabled.| - -## enabled Attribute - -|Value|Description| -|-----------|-----------------| -|0|Do not disable the default behavior of the common language runtime, which is to commit the full thread stack when a thread is started.| -|1|Disable the default behavior of the common language runtime, which is to commit the full thread stack when a thread is started.| - -### Child Elements - - None. - -### Parent Elements - -|Element|Description| -|-------------|-----------------| -|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| -|`runtime`|Contains information about assembly binding and garbage collection.| - -## Remarks - - The default behavior of the common language runtime is to commit the full thread stack when a thread is started. If a large number of threads must be created on a server that has limited memory, and most of those threads will use very little stack space, the server might perform better if the common language runtime does not commit the full thread stack immediately when a thread is started. - +    **\** + +## Syntax + +```xml + +``` + +## Attributes and Elements + + The following sections describe attributes, child elements, and parent elements. + +### Attributes + +|Attribute|Description| +|---------------|-----------------| +|enabled|Required attribute.

Specifies whether committing the full thread stack on thread startup (the default behavior) is disabled.| + +## enabled Attribute + +|Value|Description| +|-----------|-----------------| +|0|Do not disable the default behavior of the common language runtime, which is to commit the full thread stack when a thread is started.| +|1|Disable the default behavior of the common language runtime, which is to commit the full thread stack when a thread is started.| + +### Child Elements + + None. + +### Parent Elements + +|Element|Description| +|-------------|-----------------| +|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| +|`runtime`|Contains information about assembly binding and garbage collection.| + +## Remarks + + The default behavior of the common language runtime is to commit the full thread stack when a thread is started. If a large number of threads must be created on a server that has limited memory, and most of those threads will use very little stack space, the server might perform better if the common language runtime does not commit the full thread stack immediately when a thread is started. + > [!NOTE] -> Unmanaged hosts can use the `STARTUP_DISABLE_COMMITTHREADSTACK` startup flag in the [STARTUP_FLAGS](../../../unmanaged-api/hosting/startup-flags-enumeration.md) enumeration to accomplish the same result. - -## Example - - The following example shows how to disable the default behavior of the common language runtime, which is to commit the full thread stack on thread startup. - -```xml - - - - - -``` - +> Unmanaged hosts can use the `STARTUP_DISABLE_COMMITTHREADSTACK` startup flag in the [STARTUP_FLAGS](../../../unmanaged-api/hosting/startup-flags-enumeration.md) enumeration to accomplish the same result. + +## Example + + The following example shows how to disable the default behavior of the common language runtime, which is to commit the full thread stack on thread startup. + +```xml + + + + + +``` + ## See also - [Configure apps by using configuration files](../../index.md) diff --git a/docs/framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md b/docs/framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md index 6222119c6e0ae..88f1d479a8e35 100644 --- a/docs/framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md @@ -2,118 +2,118 @@ description: "Learn more about: Element" title: " Element" ms.date: "03/30/2017" -f1_keywords: +f1_keywords: - "http://schemas.microsoft.com/.NetConfiguration/v2.0#legacyImpersonationPolicy" - "http://schemas.microsoft.com/.NetConfiguration/v2.0#configuration/runtime/legacyImpersonationPolicy" -helpviewer_keywords: +helpviewer_keywords: - " element" - "legacyImpersonationPolicy element" ms.assetid: 6e00af10-42f3-4235-8415-1bb2db78394e --- # \ Element -Specifies that the Windows identity does not flow across asynchronous points, regardless of the flow settings for the execution context on the current thread. - +Specifies that the Windows identity does not flow across asynchronous points, regardless of the flow settings for the execution context on the current thread. + [**\**](../configuration-element.md)\   [**\**](runtime-element.md)\ -    **\** - -## Syntax - -```xml +    **\** + +## Syntax + +```xml -``` - -## Attributes and Elements - - The following sections describe attributes, child elements, and parent elements. - -### Attributes - -|Attribute|Description| -|---------------|-----------------| -|`enabled`|Required attribute.

Specifies that the does not flow across asynchronous points, regardless of the flow settings on the current thread.| - -## enabled Attribute - -|Value|Description| -|-----------|-----------------| -|`false`| flows across asynchronous points depending upon the flow settings for the current thread. This is the default.| -|`true`| does not flow across asynchronous points, regardless of the flow settings on the current thread.| - -### Child Elements - - None. - -### Parent Elements - -|Element|Description| -|-------------|-----------------| -|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| -|`runtime`|Contains information about assembly binding and garbage collection.| - -## Remarks - - In the .NET Framework versions 1.0 and 1.1, the does not flow across any user-defined asynchronous points. Starting with .NET Framework version 2.0, there is an object that contains information about the currently executing thread, and it flows across asynchronous points within an application domain. The is included in this execution context and therefore also flows across the asynchronous points, which means that if an impersonation context exists, it will flow as well. - - Starting with .NET Framework 2.0, you can use the `` element to specify that does not flow across asynchronous points. - + enabled="true|false"/> +``` + +## Attributes and Elements + + The following sections describe attributes, child elements, and parent elements. + +### Attributes + +|Attribute|Description| +|---------------|-----------------| +|`enabled`|Required attribute.

Specifies that the does not flow across asynchronous points, regardless of the flow settings on the current thread.| + +## enabled Attribute + +|Value|Description| +|-----------|-----------------| +|`false`| flows across asynchronous points depending upon the flow settings for the current thread. This is the default.| +|`true`| does not flow across asynchronous points, regardless of the flow settings on the current thread.| + +### Child Elements + + None. + +### Parent Elements + +|Element|Description| +|-------------|-----------------| +|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| +|`runtime`|Contains information about assembly binding and garbage collection.| + +## Remarks + + In the .NET Framework versions 1.0 and 1.1, the does not flow across any user-defined asynchronous points. Starting with .NET Framework version 2.0, there is an object that contains information about the currently executing thread, and it flows across asynchronous points within an application domain. The is included in this execution context and therefore also flows across the asynchronous points, which means that if an impersonation context exists, it will flow as well. + + Starting with .NET Framework 2.0, you can use the `` element to specify that does not flow across asynchronous points. + > [!NOTE] -> The common language runtime (CLR) is aware of impersonation operations performed using only managed code, not of impersonation performed outside of managed code, such as through platform invoke to unmanaged code or through direct calls to Win32 functions. Only managed objects can flow across asynchronous points, unless the `alwaysFlowImpersonationPolicy` element has been set to true (``). Setting the `alwaysFlowImpersonationPolicy` element to true specifies that the Windows identity always flows across asynchronous points, regardless of how impersonation was performed. For more information on flowing unmanaged impersonation across asynchronous points, see [\ Element](alwaysflowimpersonationpolicy-element.md). - - You can alter this default behavior in two other ways: - -1. In managed code on a per-thread basis. - - You can suppress the flow on a per-thread basis by modifying the and settings by using the , or method. - -2. In the call to the unmanaged hosting interface to load the common language runtime (CLR). - - If an unmanaged hosting interface (instead of a simple managed executable) is used to load the CLR, you can specify a special flag in the call to the [CorBindToRuntimeEx Function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md) function. To enable the compatibility mode for the entire process, set the `flags` parameter for [CorBindToRuntimeEx Function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md) to STARTUP_LEGACY_IMPERSONATION. - - For more information, see the [\ Element](alwaysflowimpersonationpolicy-element.md). - -## Configuration File - - In a .NET Framework application, this element can be used only in the application configuration file. - - For an ASP.NET application, the impersonation flow can be configured in the aspnet.config file found in the \\Microsoft.NET\Framework\vx.x.xxxx directory. - - ASP.NET by default disables the impersonation flow in the aspnet.config file by using the following configuration settings: - +> The common language runtime (CLR) is aware of impersonation operations performed using only managed code, not of impersonation performed outside of managed code, such as through platform invoke to unmanaged code or through direct calls to Win32 functions. Only managed objects can flow across asynchronous points, unless the `alwaysFlowImpersonationPolicy` element has been set to true (``). Setting the `alwaysFlowImpersonationPolicy` element to true specifies that the Windows identity always flows across asynchronous points, regardless of how impersonation was performed. For more information on flowing unmanaged impersonation across asynchronous points, see [\ Element](alwaysflowimpersonationpolicy-element.md). + + You can alter this default behavior in two other ways: + +1. In managed code on a per-thread basis. + + You can suppress the flow on a per-thread basis by modifying the and settings by using the , or method. + +2. In the call to the unmanaged hosting interface to load the common language runtime (CLR). + + If an unmanaged hosting interface (instead of a simple managed executable) is used to load the CLR, you can specify a special flag in the call to the [CorBindToRuntimeEx Function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md) function. To enable the compatibility mode for the entire process, set the `flags` parameter for [CorBindToRuntimeEx Function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md) to STARTUP_LEGACY_IMPERSONATION. + + For more information, see the [\ Element](alwaysflowimpersonationpolicy-element.md). + +## Configuration File + + In a .NET Framework application, this element can be used only in the application configuration file. + + For an ASP.NET application, the impersonation flow can be configured in the aspnet.config file found in the \\Microsoft.NET\Framework\vx.x.xxxx directory. + + ASP.NET by default disables the impersonation flow in the aspnet.config file by using the following configuration settings: + ``` xml - - - - - - -``` - - In ASP.NET, if you want to allow the flow of impersonation instead, you must explicitly use the following configuration settings: - -```xml - - - - - - -``` - -## Example - - The following example shows how to specify the legacy behavior that does not flow the Windows identity across asynchronous points. - -```xml - - - - - -``` - + + + + + + +``` + + In ASP.NET, if you want to allow the flow of impersonation instead, you must explicitly use the following configuration settings: + +```xml + + + + + + +``` + +## Example + + The following example shows how to specify the legacy behavior that does not flow the Windows identity across asynchronous points. + +```xml + + + + + +``` + ## See also - [Configure apps by using configuration files](../../index.md) diff --git a/docs/framework/configure-apps/file-schema/runtime/prefercominsteadofmanagedremoting-element.md b/docs/framework/configure-apps/file-schema/runtime/prefercominsteadofmanagedremoting-element.md index d0b627421512d..0e57062653e88 100644 --- a/docs/framework/configure-apps/file-schema/runtime/prefercominsteadofmanagedremoting-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/prefercominsteadofmanagedremoting-element.md @@ -2,75 +2,75 @@ description: "Learn more about: Element" title: " Element" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - " element" - "PreferComInsteadOfManagedRemoting element" ms.assetid: a279a42a-c415-4e79-88cf-64244ebda613 --- # \ Element -Specifies whether the runtime will use COM interop instead of remoting for all calls across application domain boundaries. - +Specifies whether the runtime will use COM interop instead of remoting for all calls across application domain boundaries. + [**\**](../configuration-element.md)\   [**\**](runtime-element.md)\ -    **\** - -## Syntax - -```xml - -``` - -## Attributes and Elements - - The following sections describe attributes, child elements, and parent elements. - -### Attributes - -|Attribute|Description| -|---------------|-----------------| -|`enabled`|Required attribute.

Indicates whether the runtime will use COM interop instead of remoting across application domain boundaries.| - -## enabled Attribute - -|Value|Description| -|-----------|-----------------| -|`false`|The runtime will use remoting across application domain boundaries. This is the default.| -|`true`|The runtime will use COM interop across application domain boundaries.| - -### Child Elements - - None. - -### Parent Elements - -|Element|Description| -|-------------|-----------------| -|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| -|`runtime`|Contains information about assembly binding and garbage collection.| - -## Remarks - - When you set the `enabled` attribute to `true`, the runtime behaves as follows: - -- The runtime does not call [IUnknown::QueryInterface](/windows/win32/api/unknwn/nf-unknwn-iunknown-queryinterface(q)) for an [IManagedObject](../../../unmanaged-api/hosting/imanagedobject-interface.md) interface when an [IUnknown](/windows/win32/api/unknwn/nn-unknwn-iunknown) interface enters the domain through a COM interface. Instead, it constructs a [Runtime Callable Wrapper](../../../../standard/native-interop/runtime-callable-wrapper.md) (RCW) around the object. - -- The runtime returns E_NOINTERFACE when it receives a `QueryInterface` call for an [IManagedObject](../../../unmanaged-api/hosting/imanagedobject-interface.md) interface for any [COM Callable Wrapper](../../../../standard/native-interop/com-callable-wrapper.md) (CCW) that has been created in this domain. - - These two behaviors ensure that all calls over COM interfaces between managed objects across application domain boundaries use COM and COM interop instead of remoting. - -## Example - - The following example shows how to specify that the runtime should use COM interop across isolation boundaries: - -```xml - - - - - -``` - +    **\** + +## Syntax + +```xml + +``` + +## Attributes and Elements + + The following sections describe attributes, child elements, and parent elements. + +### Attributes + +|Attribute|Description| +|---------------|-----------------| +|`enabled`|Required attribute.

Indicates whether the runtime will use COM interop instead of remoting across application domain boundaries.| + +## enabled Attribute + +|Value|Description| +|-----------|-----------------| +|`false`|The runtime will use remoting across application domain boundaries. This is the default.| +|`true`|The runtime will use COM interop across application domain boundaries.| + +### Child Elements + + None. + +### Parent Elements + +|Element|Description| +|-------------|-----------------| +|`configuration`|The root element in every configuration file used by the common language runtime and .NET Framework applications.| +|`runtime`|Contains information about assembly binding and garbage collection.| + +## Remarks + + When you set the `enabled` attribute to `true`, the runtime behaves as follows: + +- The runtime does not call [IUnknown::QueryInterface](/windows/win32/api/unknwn/nf-unknwn-iunknown-queryinterface(q)) for an [IManagedObject](../../../unmanaged-api/hosting/imanagedobject-interface.md) interface when an [IUnknown](/windows/win32/api/unknwn/nn-unknwn-iunknown) interface enters the domain through a COM interface. Instead, it constructs a [Runtime Callable Wrapper](../../../../standard/native-interop/runtime-callable-wrapper.md) (RCW) around the object. + +- The runtime returns E_NOINTERFACE when it receives a `QueryInterface` call for an [IManagedObject](../../../unmanaged-api/hosting/imanagedobject-interface.md) interface for any [COM Callable Wrapper](../../../../standard/native-interop/com-callable-wrapper.md) (CCW) that has been created in this domain. + + These two behaviors ensure that all calls over COM interfaces between managed objects across application domain boundaries use COM and COM interop instead of remoting. + +## Example + + The following example shows how to specify that the runtime should use COM interop across isolation boundaries: + +```xml + + + + + +``` + ## See also - [Configure apps by using configuration files](../../index.md) diff --git a/docs/framework/configure-apps/file-schema/startup/requiredruntime-element.md b/docs/framework/configure-apps/file-schema/startup/requiredruntime-element.md index e095fca5e626f..f047e116b9cee 100644 --- a/docs/framework/configure-apps/file-schema/startup/requiredruntime-element.md +++ b/docs/framework/configure-apps/file-schema/startup/requiredruntime-element.md @@ -2,10 +2,10 @@ description: "Learn more about: element" title: " element" ms.date: "03/30/2017" -f1_keywords: +f1_keywords: - "http://schemas.microsoft.com/.NetConfiguration/v2.0#requiredRuntime" - "http://schemas.microsoft.com/.NetConfiguration/v2.0#configuration/startup/requiredRuntime" -helpviewer_keywords: +helpviewer_keywords: - "requiredRuntime element" - " element" - "container tags, element" @@ -15,14 +15,14 @@ ms.assetid: 9fa1639e-beb8-43be-b7a4-12f7b229c34b Specifies that the application supports only version 1.0 of the common language runtime. This element is deprecated and should no longer be used. The [`supportedRuntime`](supportedruntime-element.md) element should be used instead. -[**\**](../configuration-element.md) -  [**\**](startup-element.md) -    **\** +[**\**](../configuration-element.md) +  [**\**](startup-element.md) +    **\** ## Syntax ```xml - ``` diff --git a/docs/framework/configure-apps/file-schema/startup/startup-element.md b/docs/framework/configure-apps/file-schema/startup/startup-element.md index 96e3a6ba7f122..845d17e8a196c 100644 --- a/docs/framework/configure-apps/file-schema/startup/startup-element.md +++ b/docs/framework/configure-apps/file-schema/startup/startup-element.md @@ -2,10 +2,10 @@ description: "Learn more about: element" title: " element" ms.date: "03/30/2017" -f1_keywords: +f1_keywords: - "http://schemas.microsoft.com/.NetConfiguration/v2.0#configuration/startup" - "http://schemas.microsoft.com/.NetConfiguration/v2.0#startup" -helpviewer_keywords: +helpviewer_keywords: - "container tags, element" - " element" - "startup element" @@ -15,8 +15,8 @@ ms.assetid: 536acfd8-f827-452f-838a-e14fa3b87621 Specifies common language runtime startup information. -[**\**](../configuration-element.md) -  **\** +[**\**](../configuration-element.md) +  **\** ## Syntax diff --git a/docs/framework/configure-apps/file-schema/startup/supportedruntime-element.md b/docs/framework/configure-apps/file-schema/startup/supportedruntime-element.md index 935a06e70e0ec..28111e727a909 100644 --- a/docs/framework/configure-apps/file-schema/startup/supportedruntime-element.md +++ b/docs/framework/configure-apps/file-schema/startup/supportedruntime-element.md @@ -2,21 +2,21 @@ description: "Learn more about: element" title: " configuration element - .NET" ms.date: "04/02/2019" -f1_keywords: +f1_keywords: - "http://schemas.microsoft.com/.NetConfiguration/v2.0#supportedRuntime" - "http://schemas.microsoft.com/.NetConfiguration/v2.0#configuration/startup/supportedRuntime" -helpviewer_keywords: +helpviewer_keywords: - "supportedRuntime element" - " element" ms.assetid: 1ae16e23-afbe-4de4-b413-bc457f37b69f --- # \ element -Specifies which common language runtime version and, optionally, .NET Framework version the application supports. +Specifies which common language runtime version and, optionally, .NET Framework version the application supports. -[\](../configuration-element.md) -  [\](startup-element.md) -    **\** +[\](../configuration-element.md) +  [\](startup-element.md) +    **\** ## Syntax @@ -38,12 +38,12 @@ If the **\** element is not present in the application configu The **\** element should be used by all applications built using version 1.1 or later of the runtime. Applications built to support only version 1.0 of the runtime must use the [\](requiredruntime-element.md) element. > [!NOTE] -> If you use the [CorBindToRuntimeByCfg](../../../unmanaged-api/hosting/corbindtoruntimebycfg-function.md) function to specify the configuration file, you must use the `` element for all versions of the runtime. The `` element is ignored when you use [CorBindToRuntimeByCfg](../../../unmanaged-api/hosting/corbindtoruntimebycfg-function.md). - +> If you use the [CorBindToRuntimeByCfg](../../../unmanaged-api/hosting/corbindtoruntimebycfg-function.md) function to specify the configuration file, you must use the `` element for all versions of the runtime. The `` element is ignored when you use [CorBindToRuntimeByCfg](../../../unmanaged-api/hosting/corbindtoruntimebycfg-function.md). + For apps that support versions of the runtime from the .NET Framework 1.1 through 3.5, when multiple versions of the runtime are supported, the first element should specify the most preferred version of the runtime, and the last element should specify the least preferred version. For apps that support the .NET Framework 4.0 or later versions, the `version` attribute indicates the CLR version, which is common to the .NET Framework 4 and later versions, and the `sku` attribute indicates the single .NET Framework version that the app targets. If the **\** element with the `sku` attribute is present in the configuration file and the installed .NET Framework version is lower than the specified supported version, the application fails to run and instead displays a message asking to install the supported version. Otherwise, the application attempts to run on any installed version, but it may behave unexpectedly if it is not fully compatible with that version. (For compatibility differences between versions of .NET Framework, see [Application compatibility in the .NET Framework](../../../migration-guide/application-compatibility.md).) Therefore, we recommend that you include this element in the application configuration file for easier error diagnostics. (The configuration file automatically generated by Visual Studio when creating a new project already contains it.) - + > [!NOTE] > If your application uses legacy activation paths, such as the [CorBindToRuntimeEx function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md), and you want those paths to activate version 4 of the CLR instead of an earlier version, or if your application is built with the .NET Framework 4 but has a dependency on a mixed-mode assembly built with an earlier version of the .NET Framework, it is not sufficient to specify the .NET Framework 4 in the list of supported runtimes. In addition, in the [\ element](startup-element.md) in your configuration file, you must set the `useLegacyV2RuntimeActivationPolicy` attribute to `true`. However, setting this attribute to `true` means that all components built with earlier versions of the .NET Framework are run using the .NET Framework 4 instead of the runtimes they were built with. diff --git a/docs/framework/deployment/initialization-errors-managing-the-user-experience.md b/docs/framework/deployment/initialization-errors-managing-the-user-experience.md index ff8963ef0e8d0..c4cdaf6493e7a 100644 --- a/docs/framework/deployment/initialization-errors-managing-the-user-experience.md +++ b/docs/framework/deployment/initialization-errors-managing-the-user-experience.md @@ -21,15 +21,10 @@ The CLR provides logging infrastructure to help you debug CLR activation issues, The CLR activation APIs return HRESULT codes to report the result of an activation operation to a host. CLR hosts should always consult these return values before proceeding with additional operations. - CLR_E_SHIM_RUNTIMELOAD - - CLR_E_SHIM_RUNTIMEEXPORT - - CLR_E_SHIM_INSTALLROOT - - CLR_E_SHIM_INSTALLCOMP - - CLR_E_SHIM_LEGACYRUNTIMEALREADYBOUND - - CLR_E_SHIM_SHUTDOWNINPROGRESS ## UI for initialization errors diff --git a/docs/framework/unmanaged-api/alink/addfile-method.md b/docs/framework/unmanaged-api/alink/addfile-method.md index d2d583ea7a1f9..e84a9e967313d 100644 --- a/docs/framework/unmanaged-api/alink/addfile-method.md +++ b/docs/framework/unmanaged-api/alink/addfile-method.md @@ -2,62 +2,62 @@ description: "Learn more about: AddFile Method" title: "AddFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.AddFile" - "AddFile" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddFile" -helpviewer_keywords: +helpviewer_keywords: - "AddFile method" ms.assetid: 9e707abb-f905-4568-9356-12aa21d1b11c -topic_type: +topic_type: - "apiref" --- # AddFile Method -Adds files to the assembly. Can also be used to create unbound modules. - -## Syntax - -```cpp -HRESULT AddFile( - mdAssembly AssemblyID, - LPCWSTR pszFilename, - DWORD dwFlags, - IMetaDataEmit* pEmitter, - mdFile* pFileToken -) PURE; -``` - -## Parameters +Adds files to the assembly. Can also be used to create unbound modules. - `AssemblyID` - Unique ID of the assembly to be augmented. - - `pszFilename` - Fully qualified name of file to be added. - - `dwFlags` - COM+ FileDef flags such as `ffContainsNoMetaData` and `ffWriteable`. `dwFlags` is passed to [DefineFile Method](../metadata/imetadataassemblyemit-definefile-method.md). - - `pEmitter` - [IMetaDataEmit Interface](../metadata/imetadataemit-interface.md) interface to be used to emit metadata, if necessary. - - `pFileToken` - Pointer to where the unique ID of the added file will be stored. - -## Return Value +## Syntax - Returns S_OK if the method succeeds. - -## Requirements +```cpp +HRESULT AddFile( + mdAssembly AssemblyID, + LPCWSTR pszFilename, + DWORD dwFlags, + IMetaDataEmit* pEmitter, + mdFile* pFileToken +) PURE; +``` + +## Parameters + + `AssemblyID`\ + Unique ID of the assembly to be augmented. + + `pszFilename`\ + Fully qualified name of file to be added. + + `dwFlags`\ + COM+ FileDef flags such as `ffContainsNoMetaData` and `ffWriteable`. `dwFlags` is passed to [DefineFile Method](../../../core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md). + + `pEmitter`\ + [IMetaDataEmit Interface](../../../core/unmanaged-api/metadata/imetadataemit-interface.md) interface to be used to emit metadata, if necessary. + + `pFileToken`\ + Pointer to where the unique ID of the added file will be stored. + +## Return Value + + Returns `S_OK` if the method succeeds. + +## Requirements + + Requires alink.h. - Requires alink.h. - ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/addfile2-method.md b/docs/framework/unmanaged-api/alink/addfile2-method.md index 2557daf993082..a67a20ed47a5c 100644 --- a/docs/framework/unmanaged-api/alink/addfile2-method.md +++ b/docs/framework/unmanaged-api/alink/addfile2-method.md @@ -2,62 +2,62 @@ description: "Learn more about: AddFile2 Method" title: "AddFile2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "AddFile2" - "IALink2.AddFile2" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddFile2" -helpviewer_keywords: +helpviewer_keywords: - "AddFile2 method" ms.assetid: 03bc49bf-a89b-4fb6-a88d-97482e061195 -topic_type: +topic_type: - "apiref" --- # AddFile2 Method -Adds files to the assembly. Can also be used to create unbound modules. - -## Syntax - -```cpp -HRESULT AddFile2( - mdAssembly AssemblyID, - LPCWSTR pszFilename, - DWORD dwFlags, - IMetaDataEmit2* pEmitter, - mdFile* pFileToken -) PURE; -``` - -## Parameters +Adds files to the assembly. Can also be used to create unbound modules. - `AssemblyID` - ID for the assembly to which the file is added. - - `pszFilename` - Name of the file to be added. - - `dwFlags` - COM+ `FileDef` flags such as `ffContainsNoMetaData` and `ffWriteable`. `dwFlags` is passed to [DefineFile Method](../metadata/imetadataassemblyemit-definefile-method.md). - - `pEmitter` - Interface to [IMetaDataEmit2 Interface](../metadata/imetadataemit2-interface.md) interface. - - `pFileToken` - Receives ID for the file being added. - -## Return Value +## Syntax - Returns S_OK if the method succeeds. - -## Requirements +```cpp +HRESULT AddFile2( + mdAssembly AssemblyID, + LPCWSTR pszFilename, + DWORD dwFlags, + IMetaDataEmit2* pEmitter, + mdFile* pFileToken +) PURE; +``` + +## Parameters + + `AssemblyID` + ID for the assembly to which the file is added. + + `pszFilename` + Name of the file to be added. + + `dwFlags` + COM+ `FileDef` flags such as `ffContainsNoMetaData` and `ffWriteable`. `dwFlags` is passed to [DefineFile Method](../../../core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md). + + `pEmitter` + Interface to [IMetaDataEmit2 Interface](../../../core/unmanaged-api/metadata/imetadataemit2-interface.md) interface. + + `pFileToken` + Receives ID for the file being added. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. - Requires alink.h. - ## See also - [IALink2 Interface](ialink2-interface.md) diff --git a/docs/framework/unmanaged-api/alink/addimport-method.md b/docs/framework/unmanaged-api/alink/addimport-method.md index 3c616e3595d62..f71bc7acd2d5c 100644 --- a/docs/framework/unmanaged-api/alink/addimport-method.md +++ b/docs/framework/unmanaged-api/alink/addimport-method.md @@ -2,58 +2,58 @@ description: "Learn more about: AddImport Method" title: "AddImport Method" ms.date: "03/30/2017" -api_name: +api_name: - "AddImport" - "IALink.AddImport" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddImport" -helpviewer_keywords: +helpviewer_keywords: - "AddImport method" ms.assetid: 4fedf8a0-08c8-43d0-aa00-20f2a521c991 -topic_type: +topic_type: - "apiref" --- # AddImport Method -Adds imports to the assembly. - -## Syntax - -```cpp -HRESULT AddImport( - mdAssembly AssemblyID, - mdToken ImportToken, - DWORD dwFlags, - mdFile* pFileToken -) PURE; -``` - -## Parameters - - `AssemblyID` - Unique ID of assembly to be augmented. - - `ImportToken` - Unique ID, retrieved from [ImportFile Method](importfile-method.md), of file to be imported. - - `dwFlags` - COM+ FileDef flags such as `ffContainsNoMetaData` and `ffWriteable`. `dwFlags` is passed to [DefineFile Method](../metadata/imetadataassemblyemit-definefile-method.md). - - `pFileToken` - Pointer to token that receives the ID for the resulting file. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h - +Adds imports to the assembly. + +## Syntax + +```cpp +HRESULT AddImport( + mdAssembly AssemblyID, + mdToken ImportToken, + DWORD dwFlags, + mdFile* pFileToken +) PURE; +``` + +## Parameters + + `AssemblyID` + Unique ID of assembly to be augmented. + + `ImportToken` + Unique ID, retrieved from [ImportFile Method](importfile-method.md), of file to be imported. + + `dwFlags` + COM+ FileDef flags such as `ffContainsNoMetaData` and `ffWriteable`. `dwFlags` is passed to [DefineFile Method](../../../core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md). + + `pFileToken` + Pointer to token that receives the ID for the resulting file. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/embedresource-method.md b/docs/framework/unmanaged-api/alink/embedresource-method.md index 847fd7510ab95..48b296128da55 100644 --- a/docs/framework/unmanaged-api/alink/embedresource-method.md +++ b/docs/framework/unmanaged-api/alink/embedresource-method.md @@ -2,62 +2,62 @@ description: "Learn more about: EmbedResource Method" title: "EmbedResource Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.EmbedResource" - "EmbedResource" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EmbedResource" -helpviewer_keywords: +helpviewer_keywords: - "EmbedResource method" ms.assetid: 667bd954-6dc6-4020-a3cb-0e8224179993 -topic_type: +topic_type: - "apiref" --- # EmbedResource Method -Declares an embedded resource. This method does not actually embed the resource. - -## Syntax - -```cpp -HRESULT EmbedResource( - mdAssembly AssemblyID, - mdToken FileToken, - LPCWSTR pszResourceName, - DWORD dwOffset, - DWORD dwFlags -) PURE; -``` - -## Parameters +Declares an embedded resource. This method does not actually embed the resource. - `AssemblyID` - ID of the assembly. - - `FileToken` - File token or assembly ID of file that contains the resource. - - `pszResourceName` - Name of the resource. - - `dwOffset` - Offset of resource from RVA. - - `dwFlags` - Accessibility flags such as `mrPublic` and `mrPrivate`. These flags may be passed to [DefineExportedType Method](../metadata/imetadataassemblyemit-defineexportedtype-method.md). - -## Return Value +## Syntax - Returns S_OK if the method succeeds. - -## Requirements +```cpp +HRESULT EmbedResource( + mdAssembly AssemblyID, + mdToken FileToken, + LPCWSTR pszResourceName, + DWORD dwOffset, + DWORD dwFlags +) PURE; +``` + +## Parameters + + `AssemblyID` + ID of the assembly. + + `FileToken` + File token or assembly ID of file that contains the resource. + + `pszResourceName` + Name of the resource. + + `dwOffset` + Offset of resource from RVA. + + `dwFlags` + Accessibility flags such as `mrPublic` and `mrPrivate`. These flags may be passed to [DefineExportedType Method](../../../core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md). + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. - Requires alink.h. - ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/exportnestedtype-method.md b/docs/framework/unmanaged-api/alink/exportnestedtype-method.md index 01d1623eecc9b..812d96c37cc7d 100644 --- a/docs/framework/unmanaged-api/alink/exportnestedtype-method.md +++ b/docs/framework/unmanaged-api/alink/exportnestedtype-method.md @@ -2,70 +2,70 @@ description: "Learn more about: ExportNestedType Method" title: "ExportNestedType Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.ExportNestedType" - "ExportNestedType" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ExportNestedType" -helpviewer_keywords: +helpviewer_keywords: - "ExportNestedType method" ms.assetid: dec7df60-4d30-47c8-99db-72e0419e5f76 -topic_type: +topic_type: - "apiref" --- # ExportNestedType Method -Specifies nested types as exportable. The [ExportType Method](exporttype-method.md) can also export nested types, but this method is faster. - -## Syntax - -```cpp -HRESULT ExportNestedType( - mdAssembly AssemblyID, - mdToken FileToken, - mdTypeDef TypeToken, - mdExportedType ParentType, - LPCWSTR pszTypename, - DWORD dwFlags, - mdExportedType* pType +Specifies nested types as exportable. The [ExportType Method](exporttype-method.md) can also export nested types, but this method is faster. + +## Syntax + +```cpp +HRESULT ExportNestedType( + mdAssembly AssemblyID, + mdToken FileToken, + mdTypeDef TypeToken, + mdExportedType ParentType, + LPCWSTR pszTypename, + DWORD dwFlags, + mdExportedType* pType ) PURE; -``` - -## Parameters - - `AssemblyID` - ID of assembly to export from. - - `FileToken` - File token or Assembly of file that defines the type to be made exportable. - - `TypeToken` - Type token of type to be made exportable. - - `ParentType` - Token of parent type. - - `pszTypename` - Fully qualified type name to export. - - `dwFlags` - `ComType` flags such as `tdPublic` or `tdNested`. This value may be passed to [DefineExportedType Method](../metadata/imetadataassemblyemit-defineexportedtype-method.md). - - `pType` - Receives token for exported type. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h - +``` + +## Parameters + + `AssemblyID` + ID of assembly to export from. + + `FileToken` + File token or Assembly of file that defines the type to be made exportable. + + `TypeToken` + Type token of type to be made exportable. + + `ParentType` + Token of parent type. + + `pszTypename` + Fully qualified type name to export. + + `dwFlags` + `ComType` flags such as `tdPublic` or `tdNested`. This value may be passed to [DefineExportedType Method](../../../core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md). + + `pType` + Receives token for exported type. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/exporttype-method.md b/docs/framework/unmanaged-api/alink/exporttype-method.md index de68be808ffc7..12d9ee9707b78 100644 --- a/docs/framework/unmanaged-api/alink/exporttype-method.md +++ b/docs/framework/unmanaged-api/alink/exporttype-method.md @@ -2,65 +2,65 @@ description: "Learn more about: ExportType Method" title: "ExportType Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.ExportType" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ExportType" -helpviewer_keywords: +helpviewer_keywords: - "ExportType method" ms.assetid: 91a7ce63-f5b8-4f16-b2c4-e1d0baa88944 -topic_type: +topic_type: - "apiref" --- # ExportType Method -Specifies that a type is exportable. - -## Syntax - -```cpp -HRESULT ExportType( - mdAssembly AssemblyID, - mdToken FileToken, - mdTypeDef TypeToken, - LPCWSTR pszTypename, - DWORD dwFlags, - mdExportedType* pType -) PURE; -``` - -## Parameters - - `AssemblyID` - ID of the assembly to export from. - - `FileToken` - File token or assembly ID of file that defines the exportable type. - - `TypeToken` - Token of type to be made exportable. - - `pszTypename` - Fully qualified type name to be made exportable. - - `dwFlags` - `ComType` flags such as `tdPublic` or `tdNested`. This parameter may be passed to [DefineExportedType Method](../metadata/imetadataassemblyemit-defineexportedtype-method.md). - - `pType` - Receives token for exported type. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h - +Specifies that a type is exportable. + +## Syntax + +```cpp +HRESULT ExportType( + mdAssembly AssemblyID, + mdToken FileToken, + mdTypeDef TypeToken, + LPCWSTR pszTypename, + DWORD dwFlags, + mdExportedType* pType +) PURE; +``` + +## Parameters + + `AssemblyID` + ID of the assembly to export from. + + `FileToken` + File token or assembly ID of file that defines the exportable type. + + `TypeToken` + Token of type to be made exportable. + + `pszTypename` + Fully qualified type name to be made exportable. + + `dwFlags` + `ComType` flags such as `tdPublic` or `tdNested`. This parameter may be passed to [DefineExportedType Method](../../../core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md). + + `pType` + Receives token for exported type. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/exporttypeforwarder-method.md b/docs/framework/unmanaged-api/alink/exporttypeforwarder-method.md index ecd1692e7ad65..38ab04c5ae872 100644 --- a/docs/framework/unmanaged-api/alink/exporttypeforwarder-method.md +++ b/docs/framework/unmanaged-api/alink/exporttypeforwarder-method.md @@ -2,57 +2,57 @@ description: "Learn more about: ExportTypeForwarder Method" title: "ExportTypeForwarder Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.ExportTypeForwarder" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ExportTypeForwarder" -helpviewer_keywords: +helpviewer_keywords: - "ExportTypeForwarder method" ms.assetid: 55989fa9-ab43-4f08-8eb6-2eb56fa7ca76 -topic_type: +topic_type: - "apiref" --- # ExportTypeForwarder Method -Adds a type forwarder to the type table of the given assembly. - -## Syntax - -```cpp -HRESULT ExportTypeForwarder( - mdAssemblyRef tkAssemblyRef, - LPCWSTR pszTypename, - DWORD dwFlags, - mdExportedType* pType -) PURE; -``` - -## Parameters - - `tkAssemblyRef` - Reference to the assembly to which the type forwarder refers. - - `pszTypename` - Fully qualified type name to export. - - `dwFlags` - `ComType` flags such as `tdPublic` or `tdNested`. This value may be passed to [DefineExportedType Method](../metadata/imetadataassemblyemit-defineexportedtype-method.md). - - `pType` - Receives the token of the exported type. This is necessary only for emitting nested types. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h - +Adds a type forwarder to the type table of the given assembly. + +## Syntax + +```cpp +HRESULT ExportTypeForwarder( + mdAssemblyRef tkAssemblyRef, + LPCWSTR pszTypename, + DWORD dwFlags, + mdExportedType* pType +) PURE; +``` + +## Parameters + + `tkAssemblyRef` + Reference to the assembly to which the type forwarder refers. + + `pszTypename` + Fully qualified type name to export. + + `dwFlags` + `ComType` flags such as `tdPublic` or `tdNested`. This value may be passed to [DefineExportedType Method](../../../core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md). + + `pType` + Receives the token of the exported type. This is necessary only for emitting nested types. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/getscope-method.md b/docs/framework/unmanaged-api/alink/getscope-method.md index 1efa7a4210bcd..d3de3b3d3ceb7 100644 --- a/docs/framework/unmanaged-api/alink/getscope-method.md +++ b/docs/framework/unmanaged-api/alink/getscope-method.md @@ -2,57 +2,57 @@ description: "Learn more about: GetScope Method" title: "GetScope Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.GetScope" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetScope" -helpviewer_keywords: +helpviewer_keywords: - "GetScope method" ms.assetid: e1555328-2c71-4ece-b357-9eb6d3a8efc4 -topic_type: +topic_type: - "apiref" --- # GetScope Method -Gets an import scope. - -## Syntax - -```cpp -HRESULT GetScope( - mdAssembly AssemblyID, - mdToken FileToken, - DWORD dwScope, - IMetaDataImport** ppImportScope -) PURE; -``` - -## Parameters - - `AssemblyID` - Unique ID of assembly to import to. - - `FileToken` - Unique ID of the file to import from. - - `dwScope` - Zero-based scope to import. - - `ppImportScope` - Receives [IMetaDataImport Interface](../metadata/imetadataimport-interface.md) interface for the scope. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h - +Gets an import scope. + +## Syntax + +```cpp +HRESULT GetScope( + mdAssembly AssemblyID, + mdToken FileToken, + DWORD dwScope, + IMetaDataImport** ppImportScope +) PURE; +``` + +## Parameters + + `AssemblyID` + Unique ID of assembly to import to. + + `FileToken` + Unique ID of the file to import from. + + `dwScope` + Zero-based scope to import. + + `ppImportScope` + Receives [IMetaDataImport Interface](../../../core/unmanaged-api/metadata/imetadataimport-interface.md) interface for the scope. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/getscope2-method.md b/docs/framework/unmanaged-api/alink/getscope2-method.md index 4968219b93e1e..2181db201469b 100644 --- a/docs/framework/unmanaged-api/alink/getscope2-method.md +++ b/docs/framework/unmanaged-api/alink/getscope2-method.md @@ -2,57 +2,57 @@ description: "Learn more about: GetScope2 Method" title: "GetScope2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink2.GetScope2" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetScope2" -helpviewer_keywords: +helpviewer_keywords: - "GetScope2 method" ms.assetid: 49435665-6f5a-4acd-9034-8c9244a04a63 -topic_type: +topic_type: - "apiref" --- # GetScope2 Method -Gets an import scope. - -## Syntax - -```cpp -HRESULT GetScope2( - mdAssembly AssemblyID, - mdToken FileToken, - DWORD dwScope, - IMetaDataImport2** ppImportScope +Gets an import scope. + +## Syntax + +```cpp +HRESULT GetScope2( + mdAssembly AssemblyID, + mdToken FileToken, + DWORD dwScope, + IMetaDataImport2** ppImportScope ) PURE; -``` - -## Parameters - - `AssemblyID` - ID of target assembly. - - `FileToken` - ID of file from which to import. - - `dwScope` - Zero-based scope to import. - - `ppImportScope` - Receives pointer to [IMetaDataImport2 Interface](../metadata/imetadataimport2-interface.md) interface for indicated scope. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h. - +``` + +## Parameters + + `AssemblyID` + ID of target assembly. + + `FileToken` + ID of file from which to import. + + `dwScope` + Zero-based scope to import. + + `ppImportScope` + Receives pointer to [IMetaDataImport2 Interface](../../../core/unmanaged-api/metadata/imetadataimport2-interface.md) interface for indicated scope. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. + ## See also - [IALink2 Interface](ialink2-interface.md) diff --git a/docs/framework/unmanaged-api/alink/ialink2-interface.md b/docs/framework/unmanaged-api/alink/ialink2-interface.md index 07e59dcd68397..f1722ff5c2a45 100644 --- a/docs/framework/unmanaged-api/alink/ialink2-interface.md +++ b/docs/framework/unmanaged-api/alink/ialink2-interface.md @@ -2,40 +2,40 @@ description: "Learn more about: IALink2 Interface" title: "IALink2 Interface" ms.date: "03/30/2017" -f1_keywords: +f1_keywords: - "IALink2" -helpviewer_keywords: +helpviewer_keywords: - "IALink2 interface" ms.assetid: fba62a55-36bd-401e-bcd2-5be8e2d34891 --- # IALink2 Interface -Complements the [IALink Interface](ialink-interface.md) by declaring methods that operate on newer metadata interfaces such as [IMetaDataEmit2 Interface](../metadata/imetadataemit2-interface.md). Additionally, IALink2 declares methods that provide additional usage flexibility over the original IALink interfaces. - -## In This Section - - [AddFile2 Method](addfile2-method.md) - - [EmitAssembly Method](emitassembly-method.md) - - [EmitInternalExportedTypes Method](emitinternalexportedtypes-method.md) - - [GetFileDef Method](getfiledef-method.md) - - GetPublicKeyToken Method - - [GetScope2 Method](getscope2-method.md) - - [ImportFileEx Method](importfileex-method.md) - - [ImportFileEx2 Method](importfileex2-method.md) - - [ImportTypes2 Method](importtypes2-method.md) - - [SetAssemblyFile2 Method](setassemblyfile2-method.md) - - [SetPEKind Method](setpekind-method.md) - +Complements the [IALink Interface](ialink-interface.md) by declaring methods that operate on newer metadata interfaces such as [IMetaDataEmit2 Interface](../../../core/unmanaged-api/metadata/imetadataemit2-interface.md). Additionally, IALink2 declares methods that provide additional usage flexibility over the original IALink interfaces. + +## In This Section + + [AddFile2 Method](addfile2-method.md) + + [EmitAssembly Method](emitassembly-method.md) + + [EmitInternalExportedTypes Method](emitinternalexportedtypes-method.md) + + [GetFileDef Method](getfiledef-method.md) + + GetPublicKeyToken Method + + [GetScope2 Method](getscope2-method.md) + + [ImportFileEx Method](importfileex-method.md) + + [ImportFileEx2 Method](importfileex2-method.md) + + [ImportTypes2 Method](importtypes2-method.md) + + [SetAssemblyFile2 Method](setassemblyfile2-method.md) + + [SetPEKind Method](setpekind-method.md) + ## See also - [ALink API](index.md) diff --git a/docs/framework/unmanaged-api/alink/importfile-method.md b/docs/framework/unmanaged-api/alink/importfile-method.md index 0b905636c6735..81f9a184f58ca 100644 --- a/docs/framework/unmanaged-api/alink/importfile-method.md +++ b/docs/framework/unmanaged-api/alink/importfile-method.md @@ -2,65 +2,65 @@ description: "Learn more about: ImportFile Method" title: "ImportFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.ImportFile" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ImportFile" -helpviewer_keywords: +helpviewer_keywords: - "ImportFile method" ms.assetid: bcbe321f-b83a-4e9a-9f10-8d913e244dc9 -topic_type: +topic_type: - "apiref" --- # ImportFile Method -Imports assemblies and unbound modules. - -## Syntax - -```cpp -HRESULT ImportFile( - LPCWSTR pszFilename, - LPCWSTR pszTargetName, - BOOL fSmartImport, - mdToken* pImportToken, - IMetaDataAssemblyImport** ppAssemblyScope, - DWORD* pdwCountOfScopes -) PURE; -``` - -## Parameters - - `pszFilename` - Fully qualified name of file to be imported. - - `pszTargetName` - Optional output file name that can be used to rename the file as it is linked into the assembly. - - `fSmartImport` - If TRUE, ImportTypes is used, otherwise importing must be performed manually. - - `pImportToken` - Pointer to token where a unique file ID will be stored. The file can be an assembly or a file. - - `ppAssemblyScope` - Receives pointer to [IMetaDataAssemblyImport Interface](../metadata/imetadataassemblyimport-interface.md). Can be NULL if the file is not an assembly. - - `pdwCountOfScopes` - Pointer to the count of files and/or scopes that have been imported. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h - +Imports assemblies and unbound modules. + +## Syntax + +```cpp +HRESULT ImportFile( + LPCWSTR pszFilename, + LPCWSTR pszTargetName, + BOOL fSmartImport, + mdToken* pImportToken, + IMetaDataAssemblyImport** ppAssemblyScope, + DWORD* pdwCountOfScopes +) PURE; +``` + +## Parameters + + `pszFilename` + Fully qualified name of file to be imported. + + `pszTargetName` + Optional output file name that can be used to rename the file as it is linked into the assembly. + + `fSmartImport` + If TRUE, ImportTypes is used, otherwise importing must be performed manually. + + `pImportToken` + Pointer to token where a unique file ID will be stored. The file can be an assembly or a file. + + `ppAssemblyScope` + Receives pointer to [IMetaDataAssemblyImport Interface](../../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md). Can be NULL if the file is not an assembly. + + `pdwCountOfScopes` + Pointer to the count of files and/or scopes that have been imported. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/importfile2-method.md b/docs/framework/unmanaged-api/alink/importfile2-method.md index 1881cb610e04e..17139bcde61b8 100644 --- a/docs/framework/unmanaged-api/alink/importfile2-method.md +++ b/docs/framework/unmanaged-api/alink/importfile2-method.md @@ -2,69 +2,69 @@ description: "Learn more about: ImportFile2 Method" title: "ImportFile2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.ImportFile2" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ImportFile2" -helpviewer_keywords: +helpviewer_keywords: - "ImportFile2 method" ms.assetid: 9a6be861-c260-4a35-acea-3372ea515a0f -topic_type: +topic_type: - "apiref" --- # ImportFile2 Method -Imports assemblies and unbound modules. This method is like [ImportFile Method](importfile-method.md), but works even if the file being imported does not exist on disk. - -## Syntax - -```cpp -HRESULT ImportFile2( - LPCWSTR pszFilename, - LPCWSTR pszTargetName, - IMetaDataAssemblyImport* pAssemblyScopeIn, - BOOL fSmartImport, - mdToken* pImportToken, - IMetaDataAssemblyImport** ppAssemblyScope, - DWORD* pdwCountOfScopes -) PURE; -``` - -## Parameters - - `pszFilename` - Name of file to be imported. - - `pszTargetName` - Optional output file name that can be used to rename the file as it is linked into the assembly. - - `pAssemblyScopeIn` - Optional scope [IMetaDataAssemblyImport Interface](../metadata/imetadataassemblyimport-interface.md) interface. - - `fSmartImport` - If TRUE, ImportTypes is used, otherwise importing must be performed manually. - - `pImportToken` - Receives the ID for the file or assembly. - - `ppAssemblyScope` - Receives the [IMetaDataAssemblyImport Interface](../metadata/imetadataassemblyimport-interface.md) interface. NULL if the file is not an assembly. - - `pdwCountOfScopes` - Receives the found of files and/or scopes imported. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h. - +Imports assemblies and unbound modules. This method is like [ImportFile Method](importfile-method.md), but works even if the file being imported does not exist on disk. + +## Syntax + +```cpp +HRESULT ImportFile2( + LPCWSTR pszFilename, + LPCWSTR pszTargetName, + IMetaDataAssemblyImport* pAssemblyScopeIn, + BOOL fSmartImport, + mdToken* pImportToken, + IMetaDataAssemblyImport** ppAssemblyScope, + DWORD* pdwCountOfScopes +) PURE; +``` + +## Parameters + + `pszFilename` + Name of file to be imported. + + `pszTargetName` + Optional output file name that can be used to rename the file as it is linked into the assembly. + + `pAssemblyScopeIn` + Optional scope [IMetaDataAssemblyImport Interface](../../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md) interface. + + `fSmartImport` + If TRUE, ImportTypes is used, otherwise importing must be performed manually. + + `pImportToken` + Receives the ID for the file or assembly. + + `ppAssemblyScope` + Receives the [IMetaDataAssemblyImport Interface](../../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md) interface. NULL if the file is not an assembly. + + `pdwCountOfScopes` + Receives the found of files and/or scopes imported. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/importfileex-method.md b/docs/framework/unmanaged-api/alink/importfileex-method.md index 2b1e1591a7fe7..38101032f5588 100644 --- a/docs/framework/unmanaged-api/alink/importfileex-method.md +++ b/docs/framework/unmanaged-api/alink/importfileex-method.md @@ -2,69 +2,69 @@ description: "Learn more about: ImportFileEx Method" title: "ImportFileEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink2.ImportFileEx" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ImportFileEx" -helpviewer_keywords: +helpviewer_keywords: - "ImportFileEx method" ms.assetid: ad276f3f-b303-46ac-97e0-66a377adaa4f -topic_type: +topic_type: - "apiref" --- # ImportFileEx Method -Imports indicated assembly or unbound module. - -## Syntax - -```cpp -HRESULT ImportFileEx( - LPCWSTR pszFilename, - LPCWSTR pszTargetName, - BOOL fSmartImport, - DWORD dwOpenFlags, - mdToken* pImportToken, - IMetaDataAssemblyImport** ppAssemblyScope, - DWORD* pdwCountOfScopes -) PURE; -``` - -## Parameters - - `pszFilename` - Fully qualified name of file from which to import. - - `pszTargetName` - Optional name of target file. - - `fSmartImport` - If TRUE, ImportTypes is used, otherwise importing must be performed manually. - - `dwOpenFlags` - Flags to be passed along to [OpenScope Method](../metadata/imetadatadispenser-openscope-method.md). - - `pImportToken` - Receives ID of the file being imported. - - `ppAssemblyScope` - Receives assembly import scope [IMetaDataAssemblyImport Interface](../metadata/imetadataassemblyimport-interface.md) interface. Is set to NULL if file is not an assembly. - - `pdwCountOfScopes` - Receives count of imported files and/or scopes. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h. - +Imports indicated assembly or unbound module. + +## Syntax + +```cpp +HRESULT ImportFileEx( + LPCWSTR pszFilename, + LPCWSTR pszTargetName, + BOOL fSmartImport, + DWORD dwOpenFlags, + mdToken* pImportToken, + IMetaDataAssemblyImport** ppAssemblyScope, + DWORD* pdwCountOfScopes +) PURE; +``` + +## Parameters + + `pszFilename` + Fully qualified name of file from which to import. + + `pszTargetName` + Optional name of target file. + + `fSmartImport` + If TRUE, ImportTypes is used, otherwise importing must be performed manually. + + `dwOpenFlags` + Flags to be passed along to [OpenScope Method](../../../core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md). + + `pImportToken` + Receives ID of the file being imported. + + `ppAssemblyScope` + Receives assembly import scope [IMetaDataAssemblyImport Interface](../../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md) interface. Is set to NULL if file is not an assembly. + + `pdwCountOfScopes` + Receives count of imported files and/or scopes. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. + ## See also - [IALink2 Interface](ialink2-interface.md) diff --git a/docs/framework/unmanaged-api/alink/importfileex2-method.md b/docs/framework/unmanaged-api/alink/importfileex2-method.md index 6e50edfc49965..1345bf55d88ed 100644 --- a/docs/framework/unmanaged-api/alink/importfileex2-method.md +++ b/docs/framework/unmanaged-api/alink/importfileex2-method.md @@ -2,73 +2,73 @@ description: "Learn more about: ImportFileEx2 Method" title: "ImportFileEx2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink2.ImportFileEx2" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ImportFileEx2" -helpviewer_keywords: +helpviewer_keywords: - "ImportFileEx2 method" ms.assetid: 02c789fd-16fc-48c6-9619-56e87e2a37ca -topic_type: +topic_type: - "apiref" --- # ImportFileEx2 Method -Imports assemblies and unbound modules. This method is like [ImportFile Method](importfile-method.md), but works even if the file being imported does not exist on disk. - -## Syntax - -```cpp -HRESULT ImportFileEx2( - LPCWSTR pszFilename, - LPCWSTR pszTargetName, - IMetaDataAssemblyImport* pAssemblyScopeIn, - BOOL fSmartImport, - DWORD dwOpenFlags, - mdToken* pImportToken, - IMetaDataAssemblyImport** ppAssemblyScope, - DWORD* pdwCountOfScopes -) PURE; -``` - -## Parameters - - `pszFilename` - Name of file to be imported. - - `pszTargetName` - Optional name of target file. - - `pAssemblyScopeIn` - Optional import scope [IMetaDataAssemblyImport Interface](../metadata/imetadataassemblyimport-interface.md) interface. - - `fSmartImport` - If TRUE, ImportTypes is used, otherwise importing must be performed manually. - - `dwOpenFlags` - Flags to be passed along to [OpenScope Method](../metadata/imetadatadispenser-openscope-method.md). - - `pImportToken` - Receives unique ID for the assembly or file. - - `ppAssemblyScope` - Receives assembly import scope [IMetaDataAssemblyImport Interface](../metadata/imetadataassemblyimport-interface.md) interface. Can be NULL if the file is not an assembly. - - `pdwCountOfScopes` - Receives the number of files and/or scopes imported. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h. - +Imports assemblies and unbound modules. This method is like [ImportFile Method](importfile-method.md), but works even if the file being imported does not exist on disk. + +## Syntax + +```cpp +HRESULT ImportFileEx2( + LPCWSTR pszFilename, + LPCWSTR pszTargetName, + IMetaDataAssemblyImport* pAssemblyScopeIn, + BOOL fSmartImport, + DWORD dwOpenFlags, + mdToken* pImportToken, + IMetaDataAssemblyImport** ppAssemblyScope, + DWORD* pdwCountOfScopes +) PURE; +``` + +## Parameters + + `pszFilename` + Name of file to be imported. + + `pszTargetName` + Optional name of target file. + + `pAssemblyScopeIn` + Optional import scope [IMetaDataAssemblyImport Interface](../../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md) interface. + + `fSmartImport` + If TRUE, ImportTypes is used, otherwise importing must be performed manually. + + `dwOpenFlags` + Flags to be passed along to [OpenScope Method](../../../core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md). + + `pImportToken` + Receives unique ID for the assembly or file. + + `ppAssemblyScope` + Receives assembly import scope [IMetaDataAssemblyImport Interface](../../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md) interface. Can be NULL if the file is not an assembly. + + `pdwCountOfScopes` + Receives the number of files and/or scopes imported. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. + ## See also - [IALink2 Interface](ialink2-interface.md) diff --git a/docs/framework/unmanaged-api/alink/importtypes-method.md b/docs/framework/unmanaged-api/alink/importtypes-method.md index 4d82b81339bae..af4e9d156c5bb 100644 --- a/docs/framework/unmanaged-api/alink/importtypes-method.md +++ b/docs/framework/unmanaged-api/alink/importtypes-method.md @@ -2,65 +2,65 @@ description: "Learn more about: ImportTypes Method" title: "ImportTypes Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.ImportTypes" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ImportTypes" -helpviewer_keywords: +helpviewer_keywords: - "ImportTypes method" ms.assetid: 351d4b4c-c939-486d-9471-51914a55f471 -topic_type: +topic_type: - "apiref" --- # ImportTypes Method -Initiates the importing of types from each scope imported via [ImportFile Method](importfile-method.md). - -## Syntax - -```cpp -HRESULT ImportTypes( - mdAssembly AssemblyID, - mdToken FileToken, - DWORD dwScope, - HALINKENUM* phEnum, - IMetaDataImport** ppImportScope, - DWORD* pdwCountOfTypes -) PURE; -``` - -## Parameters - - `AssemblyID` - ID of the assembly to import to. - - `FileToken` - ID of the file to import from. - - `dwScope` - Zero-based scope to import. - - `phEnum` - Receives enumerator handle for the types in this scope. - - `ppImportScope` - Optionally receives [IMetaDataImport Interface](../metadata/imetadataimport-interface.md) interface. - - `pdwCountOfTypes` - Optionally receives count of types in the indicated scope. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h - +Initiates the importing of types from each scope imported via [ImportFile Method](importfile-method.md). + +## Syntax + +```cpp +HRESULT ImportTypes( + mdAssembly AssemblyID, + mdToken FileToken, + DWORD dwScope, + HALINKENUM* phEnum, + IMetaDataImport** ppImportScope, + DWORD* pdwCountOfTypes +) PURE; +``` + +## Parameters + + `AssemblyID` + ID of the assembly to import to. + + `FileToken` + ID of the file to import from. + + `dwScope` + Zero-based scope to import. + + `phEnum` + Receives enumerator handle for the types in this scope. + + `ppImportScope` + Optionally receives [IMetaDataImport Interface](../../../core/unmanaged-api/metadata/imetadataimport-interface.md) interface. + + `pdwCountOfTypes` + Optionally receives count of types in the indicated scope. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/importtypes2-method.md b/docs/framework/unmanaged-api/alink/importtypes2-method.md index f84775468f485..c858985050043 100644 --- a/docs/framework/unmanaged-api/alink/importtypes2-method.md +++ b/docs/framework/unmanaged-api/alink/importtypes2-method.md @@ -2,65 +2,65 @@ description: "Learn more about: ImportTypes2 Method" title: "ImportTypes2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink2.ImportTypes2" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ImportTypes2" -helpviewer_keywords: +helpviewer_keywords: - "ImportTypes2 method" ms.assetid: 32f3ba58-9695-41e9-ba58-fd19e45ed396 -topic_type: +topic_type: - "apiref" --- # ImportTypes2 Method -Initiates the import of types. Call this method to begin importing types from each scope imported via [ImportFile Method](importfile-method.md). - -## Syntax - -```cpp -HRESULT ImportTypes2( - mdAssembly AssemblyID, - mdToken FileToken, - DWORD dwScope, - HALINKENUM* phEnum, - IMetaDataImport2** ppImportScope, - DWORD* pdwCountOfTypes -) PURE; -``` - -## Parameters - - `AssemblyID` - ID of assembly into which to import. - - `FileToken` - ID of file to from which to import. - - `dwScope` - Zero-based scope from which to import. - - `phEnum` - Receives enumerator handle for the types in the given scope. - - `ppImportScope` - Optionally receives [IMetaDataImport2 Interface](../metadata/imetadataimport2-interface.md) interface. - - `pdwCountOfTypes` - Optionally receives count of types in the specified scope. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h - +Initiates the import of types. Call this method to begin importing types from each scope imported via [ImportFile Method](importfile-method.md). + +## Syntax + +```cpp +HRESULT ImportTypes2( + mdAssembly AssemblyID, + mdToken FileToken, + DWORD dwScope, + HALINKENUM* phEnum, + IMetaDataImport2** ppImportScope, + DWORD* pdwCountOfTypes +) PURE; +``` + +## Parameters + + `AssemblyID` + ID of assembly into which to import. + + `FileToken` + ID of file to from which to import. + + `dwScope` + Zero-based scope from which to import. + + `phEnum` + Receives enumerator handle for the types in the given scope. + + `ppImportScope` + Optionally receives [IMetaDataImport2 Interface](../../../core/unmanaged-api/metadata/imetadataimport2-interface.md) interface. + + `pdwCountOfTypes` + Optionally receives count of types in the specified scope. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h + ## See also - [IALink2 Interface](ialink2-interface.md) diff --git a/docs/framework/unmanaged-api/alink/init-method.md b/docs/framework/unmanaged-api/alink/init-method.md index 08f55688e3db4..4c424f8f4e0d1 100644 --- a/docs/framework/unmanaged-api/alink/init-method.md +++ b/docs/framework/unmanaged-api/alink/init-method.md @@ -2,49 +2,49 @@ description: "Learn more about: Init Method" title: "Init Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.Init" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "Init" -helpviewer_keywords: +helpviewer_keywords: - "Init method" ms.assetid: e48b5c64-049f-4f93-ad87-d07ae9cd5845 -topic_type: +topic_type: - "apiref" --- # Init Method -Prepares objects implementing the [IALink Interface](ialink-interface.md) for use. - -## Syntax - -```cpp -HRESULT Init( - IMetaDataDispenserEx* pDispenser, - IMetaDataError* pErrorHandler -) PURE; -``` - -## Parameters - - `pDispenser` - [IMetaDataDispenserEx Interface](../metadata/imetadatadispenserex-interface.md) pointer to the metadata dispenser. - - `pErrorHandler` - [IMetaDataError Interface](../metadata/imetadataerror-interface.md) pointer to an optional error handling interface. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h - +Prepares objects implementing the [IALink Interface](ialink-interface.md) for use. + +## Syntax + +```cpp +HRESULT Init( + IMetaDataDispenserEx* pDispenser, + IMetaDataError* pErrorHandler +) PURE; +``` + +## Parameters + + `pDispenser` + [IMetaDataDispenserEx Interface](../../../core/unmanaged-api/metadata/imetadatadispenserex-interface.md) pointer to the metadata dispenser. + + `pErrorHandler` + [IMetaDataError Interface](../../../core/unmanaged-api/metadata/imetadataerror-interface.md) pointer to an optional error handling interface. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/linkresource-method.md b/docs/framework/unmanaged-api/alink/linkresource-method.md index 21def82a1e039..f6bfa2b4bd406 100644 --- a/docs/framework/unmanaged-api/alink/linkresource-method.md +++ b/docs/framework/unmanaged-api/alink/linkresource-method.md @@ -2,61 +2,61 @@ description: "Learn more about: LinkResource Method" title: "LinkResource Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.LinkResource" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "LinkResource" -helpviewer_keywords: +helpviewer_keywords: - "LinkResource method" ms.assetid: c404acb3-4c59-4100-9a4c-483cbdb1d736 -topic_type: +topic_type: - "apiref" --- # LinkResource Method -Links in a resource. - -## Syntax - -```cpp -HRESULT LinkResource( - mdAssembly AssemblyID, - LPCWSTR pszFileName, - LPCWSTR pszNewLocation, - LPCWSTR pszResourceName, - DWORD dwFlags -) PURE; -``` - -## Parameters +Links in a resource. - `AssemblyID` - ID of the assembly. - - `pszFileName` - Name of the file. - - `pszNewLocation` - Optional new file name. If non-NULL, `pszFileName` will be copied to pszNewLocation. - - `pszResourceName` - Name of the resource. - - `dwFlags` - Accessibility flags such as `mrPublic` and `mrPrivate`. This parameter may be passed to [DefineManifestResource Method](../metadata/imetadataassemblyemit-definemanifestresource-method.md). - -## Return Value +## Syntax - Returns S_OK if the method succeeds. - -## Requirements +```cpp +HRESULT LinkResource( + mdAssembly AssemblyID, + LPCWSTR pszFileName, + LPCWSTR pszNewLocation, + LPCWSTR pszResourceName, + DWORD dwFlags +) PURE; +``` + +## Parameters + + `AssemblyID` + ID of the assembly. + + `pszFileName` + Name of the file. + + `pszNewLocation` + Optional new file name. If non-NULL, `pszFileName` will be copied to pszNewLocation. + + `pszResourceName` + Name of the resource. + + `dwFlags` + Accessibility flags such as `mrPublic` and `mrPrivate`. This parameter may be passed to [DefineManifestResource Method](../../../core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md). + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. - Requires alink.h. - ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/setassemblyfile-method.md b/docs/framework/unmanaged-api/alink/setassemblyfile-method.md index cdb95bf4400cb..d0828716011ae 100644 --- a/docs/framework/unmanaged-api/alink/setassemblyfile-method.md +++ b/docs/framework/unmanaged-api/alink/setassemblyfile-method.md @@ -2,57 +2,57 @@ description: "Learn more about: SetAssemblyFile Method" title: "SetAssemblyFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink.SetAssemblyFile" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetAssemblyFile" -helpviewer_keywords: +helpviewer_keywords: - "SetAssemblyFile method" ms.assetid: 3a912787-f139-43ca-a841-8bbda3107ecf -topic_type: +topic_type: - "apiref" --- # SetAssemblyFile Method -Assigns the name of the assembly to be built. Not for use when producing unbound modules. - -## Syntax - -```cpp -HRESULT SetAssemblyFile( - LPCWSTR pszFilename, - IMetaDataEmit* pEmitter, - AssemblyFlags afFlags, - mdAssembly* pAssemblyID -) PURE; -``` - -## Parameters - - `pszFilename` - Fully qualified name of the manifest file. - - `pEmitter` - Pointer to [IMetaDataEmit Interface](../metadata/imetadataemit-interface.md) interface. - - `afFlags` - Flags as defined in [AssemblyFlags Enumeration](../metadata/assemblyflags-enumeration.md). - - `pAssemblyID` - Pointer to ID of resulting assembly. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h. - +Assigns the name of the assembly to be built. Not for use when producing unbound modules. + +## Syntax + +```cpp +HRESULT SetAssemblyFile( + LPCWSTR pszFilename, + IMetaDataEmit* pEmitter, + AssemblyFlags afFlags, + mdAssembly* pAssemblyID +) PURE; +``` + +## Parameters + + `pszFilename` + Fully qualified name of the manifest file. + + `pEmitter` + Pointer to [IMetaDataEmit Interface](../../../core/unmanaged-api/metadata/imetadataemit-interface.md) interface. + + `afFlags` + Flags as defined in [AssemblyFlags Enumeration](../../../core/unmanaged-api/metadata/assemblyflags-enumeration.md). + + `pAssemblyID` + Pointer to ID of resulting assembly. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. + ## See also - [IALink Interface](ialink-interface.md) diff --git a/docs/framework/unmanaged-api/alink/setassemblyfile2-method.md b/docs/framework/unmanaged-api/alink/setassemblyfile2-method.md index 738ea7879a736..c272e9a498c7b 100644 --- a/docs/framework/unmanaged-api/alink/setassemblyfile2-method.md +++ b/docs/framework/unmanaged-api/alink/setassemblyfile2-method.md @@ -2,57 +2,57 @@ description: "Learn more about: SetAssemblyFile2 Method" title: "SetAssemblyFile2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink2.SetAssemblyFile2" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetAssemblyFile2" -helpviewer_keywords: +helpviewer_keywords: - "SetAssemblyFile2 method" ms.assetid: eedb9125-1ef1-4000-abfc-7de86e5a1f17 -topic_type: +topic_type: - "apiref" --- # SetAssemblyFile2 Method -Sets the name of and options for a new assembly. Do not call this method when you produce unbound modules. - -## Syntax - -```cpp -HRESULT SetAssemblyFile2( - LPCWSTR pszFilename, - IMetaDataEmit2* pEmitter, - AssemblyFlags afFlags, - mdAssembly* pAssemblyID -) PURE; -``` - -## Parameters - - `pszFilename` - Name of manifest file. - - `pEmitter` - [IMetaDataEmit2 Interface](../metadata/imetadataemit2-interface.md) interface for this file. - - `afFlags` - Options represented by [AssemblyFlags Enumeration](../metadata/assemblyflags-enumeration.md). - - `pAssemblyID` - Receives unique ID for the assembly being constructed. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h. - +Sets the name of and options for a new assembly. Do not call this method when you produce unbound modules. + +## Syntax + +```cpp +HRESULT SetAssemblyFile2( + LPCWSTR pszFilename, + IMetaDataEmit2* pEmitter, + AssemblyFlags afFlags, + mdAssembly* pAssemblyID +) PURE; +``` + +## Parameters + + `pszFilename` + Name of manifest file. + + `pEmitter` + [IMetaDataEmit2 Interface](../../../core/unmanaged-api/metadata/imetadataemit2-interface.md) interface for this file. + + `afFlags` + Options represented by [AssemblyFlags Enumeration](../../../core/unmanaged-api/metadata/assemblyflags-enumeration.md). + + `pAssemblyID` + Receives unique ID for the assembly being constructed. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. + ## See also - [IALink2 Interface](ialink2-interface.md) diff --git a/docs/framework/unmanaged-api/alink/setpekind-method.md b/docs/framework/unmanaged-api/alink/setpekind-method.md index 763963e8510ed..bebbfbc79f461 100644 --- a/docs/framework/unmanaged-api/alink/setpekind-method.md +++ b/docs/framework/unmanaged-api/alink/setpekind-method.md @@ -2,60 +2,60 @@ description: "Learn more about: SetPEKind Method" title: "SetPEKind Method" ms.date: "03/30/2017" -api_name: +api_name: - "IALink2.SetPEKind" -api_location: +api_location: - "alink.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetPEKind" -helpviewer_keywords: +helpviewer_keywords: - "SetPEKind method" ms.assetid: 050e77ee-3014-45c0-9e29-2ebe29347b0d -topic_type: +topic_type: - "apiref" --- # SetPEKind Method -Determines the portable executable type, either machine-specific or machine-agnostic. - -## Syntax - -```cpp -HRESULT SetPEKind( - mdAssembly AssemblyID, - mdToken FileToken, - DWORD dwPEKind, - DWORD dwMachine +Determines the portable executable type, either machine-specific or machine-agnostic. + +## Syntax + +```cpp +HRESULT SetPEKind( + mdAssembly AssemblyID, + mdToken FileToken, + DWORD dwPEKind, + DWORD dwMachine ) PURE; -``` - -## Parameters - - `AssemblyID` - ID of the assembly. - - `FileToken` - Token of file for which the PE type is to be set. Can be NULL if `AssemblyID` does not indicate an unbound netmodule. - - `dwPEKind` - The type of PE, as indicated by the [CorPEKind Enumeration](../metadata/corpekind-enumeration.md). - - `dwMachine` - The target machine architecture, as indicated in the NT header. - -## Return Value - - Returns S_OK if the method succeeds. - -## Requirements - - Requires alink.h. - +``` + +## Parameters + + `AssemblyID` + ID of the assembly. + + `FileToken` + Token of file for which the PE type is to be set. Can be NULL if `AssemblyID` does not indicate an unbound netmodule. + + `dwPEKind` + The type of PE, as indicated by the [CorPEKind Enumeration](../../../core/unmanaged-api/metadata/corpekind-enumeration.md). + + `dwMachine` + The target machine architecture, as indicated in the NT header. + +## Return Value + + Returns S_OK if the method succeeds. + +## Requirements + + Requires alink.h. + ## See also -- [GetPEKind Method](../metadata/imetadataimport2-getpekind-method.md) +- [GetPEKind Method](../../../core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md) - [IALink2 Interface](ialink2-interface.md) - [IALink Interface](ialink-interface.md) - [ALink API](index.md) diff --git a/docs/framework/unmanaged-api/authenticode/certverifyauthenticodelicense-function.md b/docs/framework/unmanaged-api/authenticode/certverifyauthenticodelicense-function.md index c149eb12faf3a..18aa995ddc0f3 100644 --- a/docs/framework/unmanaged-api/authenticode/certverifyauthenticodelicense-function.md +++ b/docs/framework/unmanaged-api/authenticode/certverifyauthenticodelicense-function.md @@ -9,7 +9,7 @@ api_location: api_type: - "DLLExport" ms.assetid: 00118de7-33c6-41c4-8e1f-5d5e35e0da83 -topic_type: +topic_type: - "apiref" --- # CertVerifyAuthenticodeLicense Function diff --git a/docs/framework/unmanaged-api/common-data-types-unmanaged-api-reference.md b/docs/framework/unmanaged-api/common-data-types-unmanaged-api-reference.md index 6c51cce8990f9..d1b60cb80b556 100644 --- a/docs/framework/unmanaged-api/common-data-types-unmanaged-api-reference.md +++ b/docs/framework/unmanaged-api/common-data-types-unmanaged-api-reference.md @@ -6,35 +6,35 @@ ms.assetid: e4ab2c4c-9433-4eba-9e9a-096de406cafb --- # Common Data Types (Unmanaged API Reference) -This topic lists simple data types used by the unmanaged APIs for the .NET Framework that are defined by C/C++ `typedef` statements. These data types are typically aliases for C/C++ primitive data types. Typically, the values of these data types are opaque; that is, they are returned by a particular function or method so that they can be passed to other functions or methods without modification. - -|Data type|Definition|Defined in|Description| -|---------------|----------------|----------------|-----------------| -|AppDomainID|`typedef UINT_PTR AppDomainID;`|corprof.h|The identifier of an application domain.| -|AssemblyID|`typedef UINT_PTR AssemblyID;`|corprof.h|The identifier of an assembly.| -|ClassID|`typedef UINT_PTR ClassID;`|corprof.h|The identifier of a managed class.| -|CLRDATA_ADDRESS|`typedef ULONG64 CLRDATA_ADDRESS;`|clrdata.h|A 64-bit memory address.| -|CLRDATA_ENUM|`typedef ULONG64 CLRDATA_ADDRESS;`|Not Available|A 64-bit memory address.| -|CONNID|`typedef DWORD CONNID;`|cordebug.h, mscoree.h|The connection identifier for a thread that is connected to an instance of Microsoft SQL Server.| -|ContextID|`typedef UINT_PTR ContextID;`|corprof.h|The identifier of the context associated with a particular managed thread.| -|COR_PRF_ELT_INFO|`typedef UINT_PTR COR_PRF_ELT_INFO;`|corprof.h|An opaque handle that represents information about a particular stack frame.| -|COR_PRF_FRAME_INFO|`typedef UINT_PTR COR_PRF_FRAME_INFO;`|corprof.h|An opaque handle that points to a stack frame. It is valid only during the callback to which it is passed.| -|CORDB_ADDRESS|`typedef ULONG64 CORDB_ADDRESS;`|cordebug.h|An address in memory.| -|CORDB_CONTINUE_STATUS|`typedef DWORD CORDB_CONTINUE_STATUS;`|cordebug.h|The continuation status.| +This topic lists simple data types used by the unmanaged APIs for the .NET Framework that are defined by C/C++ `typedef` statements. These data types are typically aliases for C/C++ primitive data types. Typically, the values of these data types are opaque; that is, they are returned by a particular function or method so that they can be passed to other functions or methods without modification. + +| Data type | Definition | Defined in | Description | +|-----------------|------------------------------------|---------------|------------------------------------------| +| AppDomainID | `typedef UINT_PTR AppDomainID;` | corprof.h | The identifier of an application domain. | +| AssemblyID | `typedef UINT_PTR AssemblyID;` | corprof.h | The identifier of an assembly. | +| ClassID | `typedef UINT_PTR ClassID;` | corprof.h | The identifier of a managed class. | +| CLRDATA_ADDRESS | `typedef ULONG64 CLRDATA_ADDRESS;` | clrdata.h | A 64-bit memory address. | +| CLRDATA_ENUM | `typedef ULONG64 CLRDATA_ADDRESS;` | Not Available | A 64-bit memory address. | +|CONNID|`typedef DWORD CONNID;`|cordebug.h, mscoree.h|The connection identifier for a thread that is connected to an instance of Microsoft SQL Server.| +|ContextID|`typedef UINT_PTR ContextID;`|corprof.h|The identifier of the context associated with a particular managed thread.| +|COR_PRF_ELT_INFO|`typedef UINT_PTR COR_PRF_ELT_INFO;`|corprof.h|An opaque handle that represents information about a particular stack frame.| +|COR_PRF_FRAME_INFO|`typedef UINT_PTR COR_PRF_FRAME_INFO;`|corprof.h|An opaque handle that points to a stack frame. It is valid only during the callback to which it is passed.| +|CORDB_ADDRESS|`typedef ULONG64 CORDB_ADDRESS;`|cordebug.h|An address in memory.| +|CORDB_CONTINUE_STATUS|`typedef DWORD CORDB_CONTINUE_STATUS;`|cordebug.h|The continuation status.| |CORDB_REGISTER|`typedef ULONG64 CORDB_REGISTER;`|cordebug.h|The value of a CPU register.| -|FunctionID|`typedef UINT_PTR FunctionID;`|corprof.h|The identifier of a function or method.| -|GCHandleID|`typedef UINT_PTR GCHandleID;`|corprof.h|A garbage collection handle.| +|FunctionID|`typedef UINT_PTR FunctionID;`|corprof.h|The identifier of a function or method.| +|GCHandleID|`typedef UINT_PTR GCHandleID;`|corprof.h|A garbage collection handle.| |mdMethodDef|`typedef mdToken mdMethodDef;`|cordebug.h|A method definition token.| -|mdToken|`typedef UINT32 mdToken;`|corprof.h|A metadata token (a row in a metadata table).| -|ModuleID|`typedef UINT_PTR ModuleID;`|corprof.h|The identifier of an assembly module.| -|ObjectID|`typedef UINT_PTR ObjectID;`|corprof.h|The identifier of an object.| +|mdToken|`typedef UINT32 mdToken;`|corprof.h|A metadata token (a row in a metadata table).| +|ModuleID|`typedef UINT_PTR ModuleID;`|corprof.h|The identifier of an assembly module.| +|ObjectID|`typedef UINT_PTR ObjectID;`|corprof.h|The identifier of an object.| |PCCOR_SIGNATURE|`typedef SIZE_T PCCOR_SIGNATURE;`|cordebug.h|A pointer to a member or metadata signature.| -|ProcessID|`typedef UINT_PTR ProcessID;`|corprof.h|The identifier of a managed process.| -|ReJITID|`typedef UINT_PTR ReJITID;`|corprof.h|The identifier of a jitted function.| +|ProcessID|`typedef UINT_PTR ProcessID;`|corprof.h|The identifier of a managed process.| +|ReJITID|`typedef UINT_PTR ReJITID;`|corprof.h|The identifier of a jitted function.| |SIZE_T|`typedef ULONG_PTR SIZE_T;`|corsym.h|A pointer to a 64-bit memory address.| -|TASKID|`typedef UINT64 TASKID;`|cordebug.h, mscoree.h|The identifier of an [ICLRTask](./hosting/iclrtask-interface.md) instance.| -|ThreadID|`typedef UINT_PTR ThreadID;`|corprof.h|The identifier of a managed thread.| - +|TASKID|`typedef UINT64 TASKID;`|cordebug.h, mscoree.h|The identifier of an [ICLRTask](../unmanaged-api/hosting/iclrtask-interface.md) instance.| +|ThreadID|`typedef UINT_PTR ThreadID;`|corprof.h|The identifier of a managed thread.| + ## See also - [Unmanaged API Reference](index.md) diff --git a/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md b/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md index 290d21d555268..cc9936752d676 100644 --- a/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md +++ b/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md @@ -22,8 +22,8 @@ Provides methods that handle loading and unloading modules for debugging. ## Methods -|Method|Description| -|------------|-----------------| +| Method | Description | +|--------|-------------| |[OpenVirtualProcess Method](iclrdebugging-openvirtualprocess-method.md)|Gets the "ICorDebugProcess" interface that corresponds to a common language runtime (CLR) module loaded in the process.| |[CanUnloadNow Method](iclrdebugging-canunloadnow-method.md)|Determines whether a library that was provided by an [ICLRDebuggingLibraryProvider](iclrdebugginglibraryprovider-interface.md) interface is still in use or can be unloaded.| diff --git a/docs/framework/unmanaged-api/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md b/docs/framework/unmanaged-api/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md index 5a9fd2830eac6..ef6c4f550aa65 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md @@ -2,48 +2,48 @@ description: "Learn more about: ICorDebugAppDomain::GetModuleFromMetaDataInterface Method" title: "ICorDebugAppDomain::GetModuleFromMetaDataInterface Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorDebugAppDomain.GetModuleFromMetaDataInterface" -api_location: +api_location: - "mscordbi.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorDebugAppDomain::GetModuleFromMetaDataInterface" -helpviewer_keywords: +helpviewer_keywords: - "ICorDebugAppDomain::GetModuleFromMetaDatainterface method [.NET Framework debugging]" - "GetModuleFromMetaDatainterface method [.NET Framework debugging]" ms.assetid: f35225b3-5dda-4d5a-913d-b3373e9ab81e -topic_type: +topic_type: - "apiref" --- # ICorDebugAppDomain::GetModuleFromMetaDataInterface Method -Gets the module that corresponds to the given metadata interface. - -## Syntax - -```cpp -HRESULT GetModuleFromMetaDataInterface ( - [in] IUnknown *pIMetaData, - [out] ICorDebugModule **ppModule -); -``` - -## Parameters - - `pIMetaData` - [in] A pointer to an object that is one of the [Metadata interfaces](../metadata/metadata-interfaces.md). - - `ppModule` - [out] A pointer to the address of an ICorDebugModule object that represents the module corresponding to the given metadata interface. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorDebug.idl, CorDebug.h - - **Library:** CorGuids.lib - +Gets the module that corresponds to the given metadata interface. + +## Syntax + +```cpp +HRESULT GetModuleFromMetaDataInterface ( + [in] IUnknown *pIMetaData, + [out] ICorDebugModule **ppModule +); +``` + +## Parameters + + `pIMetaData` + [in] A pointer to an object that is one of the [Metadata interfaces](../../../core/unmanaged-api/metadata/metadata-interfaces.md). + + `ppModule` + [out] A pointer to the address of an ICorDebugModule object that represents the module corresponding to the given metadata interface. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorDebug.idl, CorDebug.h + + **Library:** CorGuids.lib + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] diff --git a/docs/framework/unmanaged-api/debugging/icordebugclass-gettoken-method.md b/docs/framework/unmanaged-api/debugging/icordebugclass-gettoken-method.md index 88e8ceca3c9c0..19d19358f3d0d 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugclass-gettoken-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugclass-gettoken-method.md @@ -2,48 +2,48 @@ description: "Learn more about: ICorDebugClass::GetToken Method" title: "ICorDebugClass::GetToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorDebugClass.GetToken" -api_location: +api_location: - "mscordbi.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorDebugClass::GetToken" -helpviewer_keywords: +helpviewer_keywords: - "GetToken method, ICorDebugClass interface [.NET Framework debugging]" - "ICorDebugClass::GetToken method [.NET Framework debugging]" ms.assetid: ee5c848a-eac4-4462-b07a-07ccd76a75df -topic_type: +topic_type: - "apiref" --- # ICorDebugClass::GetToken Method -Gets the `TypeDef` metadata token that references the definition of this class. - -## Syntax - -```cpp -HRESULT GetToken ( - [out] mdTypeDef *pTypeDef -); -``` - -## Parameters - - `pTypeDef` - [out] A pointer to an `mdTypeDef` token that references the definition of this class. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorDebug.idl, CorDebug.h - - **Library:** CorGuids.lib - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the `TypeDef` metadata token that references the definition of this class. + +## Syntax + +```cpp +HRESULT GetToken ( + [out] mdTypeDef *pTypeDef +); +``` + +## Parameters + + `pTypeDef` + [out] A pointer to an `mdTypeDef` token that references the definition of this class. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorDebug.idl, CorDebug.h + + **Library:** CorGuids.lib + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [Metadata Interfaces](../metadata/metadata-interfaces.md) +- [Metadata Interfaces](../../../core/unmanaged-api/metadata/metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/debugging/icordebugeval-createvalue-method.md b/docs/framework/unmanaged-api/debugging/icordebugeval-createvalue-method.md index 5604c5ad21938..9b71eae240e7c 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugeval-createvalue-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugeval-createvalue-method.md @@ -36,7 +36,7 @@ HRESULT CreateValue ( ## Parameters `elementType` - [in] A value of the [CorElementType](../metadata/corelementtype-enumeration.md) enumeration that specifies the type of the value. + [in] A value of the [CorElementType](../../../core/unmanaged-api/metadata/corelementtype-enumeration.md) enumeration that specifies the type of the value. `pElementClass` [in] Pointer to an [ICorDebugClass](icordebugclass-interface.md) object that specifies the class of the value, if the type is not a primitive type. diff --git a/docs/framework/unmanaged-api/debugging/icordebugilframe2-enumeratetypeparameters-method.md b/docs/framework/unmanaged-api/debugging/icordebugilframe2-enumeratetypeparameters-method.md index cd5df75cead1e..e435a1a5f18f2 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugilframe2-enumeratetypeparameters-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugilframe2-enumeratetypeparameters-method.md @@ -38,7 +38,7 @@ HRESULT EnumerateTypeParameters ( ## Remarks - Use the [IMetaDataImport2::EnumGenericParams](../metadata/imetadataimport2-enumgenericparams-method.md) method to determine how many class type parameters and method type parameters this list contains. + Use the [IMetaDataImport2::EnumGenericParams](../../../core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md) method to determine how many class type parameters and method type parameters this list contains. The type parameters are not always available. diff --git a/docs/framework/unmanaged-api/debugging/icordebugmetadatalocator-getmetadata-method.md b/docs/framework/unmanaged-api/debugging/icordebugmetadatalocator-getmetadata-method.md index 50156265e8e36..d30abdaf5b44a 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmetadatalocator-getmetadata-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmetadatalocator-getmetadata-method.md @@ -57,7 +57,7 @@ HRESULT GetMetaData( `wszPathBuffer` [out] Pointer to a buffer into which the debugger will copy the full path of the file that contains the requested metadata. - The `ofReadOnly` flag from the [CorOpenFlags](../metadata/coropenflags-enumeration.md) enumeration is used to request read-only access to the metadata in this file. + The `ofReadOnly` flag from the [CorOpenFlags](../../../core/unmanaged-api/metadata/coropenflags-enumeration.md) enumeration is used to request read-only access to the metadata in this file. ## Return Value diff --git a/docs/framework/unmanaged-api/debugging/icordebugmodule-getmetadatainterface-method.md b/docs/framework/unmanaged-api/debugging/icordebugmodule-getmetadatainterface-method.md index e148630859c01..98d4a93aec968 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmodule-getmetadatainterface-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmodule-getmetadatainterface-method.md @@ -36,11 +36,11 @@ HRESULT GetMetaDataInterface ( [in] The reference ID that specifies the metadata interface. `ppObj` - [out] A pointer to the address of an `T:IUnknown` object that is one of the [metadata interfaces](../metadata/metadata-interfaces.md). + [out] A pointer to the address of an `T:IUnknown` object that is one of the [metadata interfaces](../../../core/unmanaged-api/metadata/metadata-interfaces.md). ## Remarks - The debugger can use the `GetMetaDataInterface` method to make a copy of the original metadata for a module, which it must do in order to edit that module. The debugger calls `GetMetaDataInterface` to get an [IMetaDataEmit](../metadata/imetadataemit-interface.md) interface object for the module, then calls [IMetaDataEmit::SaveToMemory](../metadata/imetadataemit-savetomemory-method.md) to save a copy of the module's metadata to memory. + The debugger can use the `GetMetaDataInterface` method to make a copy of the original metadata for a module, which it must do in order to edit that module. The debugger calls `GetMetaDataInterface` to get an [IMetaDataEmit](../../../core/unmanaged-api/metadata/imetadataemit-interface.md) interface object for the module, then calls [IMetaDataEmit::SaveToMemory](../../../core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md) to save a copy of the module's metadata to memory. ## Requirements @@ -54,4 +54,4 @@ HRESULT GetMetaDataInterface ( ## See also -- [Metadata](../metadata/index.md) +- [Metadata](../../../core/unmanaged-api/metadata/index.md) diff --git a/docs/framework/unmanaged-api/debugging/icordebugmodule-gettoken-method.md b/docs/framework/unmanaged-api/debugging/icordebugmodule-gettoken-method.md index 6688ff5750762..4b1c7d06d52b4 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmodule-gettoken-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmodule-gettoken-method.md @@ -36,7 +36,7 @@ HRESULT GetToken( ## Remarks - The token can be passed to the [IMetaDataImport](../metadata/imetadataimport-interface.md), [IMetaDataImport2](../metadata/imetadataimport2-interface.md), and [IMetaDataAssemblyImport](../metadata/imetadataassemblyimport-interface.md) metadata import interfaces. + The token can be passed to the [IMetaDataImport](../../../core/unmanaged-api/metadata/imetadataimport-interface.md), [IMetaDataImport2](../../../core/unmanaged-api/metadata/imetadataimport2-interface.md), and [IMetaDataAssemblyImport](../../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md) metadata import interfaces. ## Requirements @@ -50,4 +50,4 @@ HRESULT GetToken( ## See also -- [Metadata](../metadata/index.md) +- [Metadata](../../../core/unmanaged-api/metadata/index.md) diff --git a/docs/framework/unmanaged-api/debugging/icordebugmodule2-applychanges-method.md b/docs/framework/unmanaged-api/debugging/icordebugmodule2-applychanges-method.md index 91ab4017f4cb1..e79dd33441a4a 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmodule2-applychanges-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmodule2-applychanges-method.md @@ -38,7 +38,7 @@ HRESULT ApplyChanges ( [in] Size, in bytes, of the delta metadata. `pbMetadata` - [in] Buffer that contains the delta metadata. The address of the buffer is returned from the [IMetaDataEmit2::SaveDeltaToMemory](../metadata/imetadataemit2-savedeltatomemory-method.md) method. + [in] Buffer that contains the delta metadata. The address of the buffer is returned from the [IMetaDataEmit2::SaveDeltaToMemory](../../../core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md) method. The relative virtual addresses (RVAs) in the metadata should be relative to the start of the CIL code. @@ -50,13 +50,13 @@ HRESULT ApplyChanges ( ## Remarks - The `pbMetadata` parameter is in a special delta metadata format (as output by [IMetaDataEmit2::SaveDeltaToMemory](../metadata/imetadataemit2-savedeltatomemory-method.md)). `pbMetadata` takes previous metadata as a base and describes individual changes to apply to that base. + The `pbMetadata` parameter is in a special delta metadata format (as output by [IMetaDataEmit2::SaveDeltaToMemory](../../../core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md)). `pbMetadata` takes previous metadata as a base and describes individual changes to apply to that base. In contrast, the `pbIL[`] parameter contains the new CIL for the updated method, and is meant to completely replace the previous CIL for that method - When the delta CIL and the metadata have been created in the debugger’s memory, the debugger calls `ApplyChanges` to send the changes into the common language runtime (CLR). The runtime updates its metadata tables, places the new CIL into the process, and sets up a just-in-time (JIT) compilation of the new CIL. When the changes have been applied, the debugger should call [IMetaDataEmit2::ResetENCLog](../metadata/imetadataemit2-resetenclog-method.md) to prepare for the next editing session. The debugger may then continue the process. + When the delta CIL and the metadata have been created in the debugger’s memory, the debugger calls `ApplyChanges` to send the changes into the common language runtime (CLR). The runtime updates its metadata tables, places the new CIL into the process, and sets up a just-in-time (JIT) compilation of the new CIL. When the changes have been applied, the debugger should call [IMetaDataEmit2::ResetENCLog](../../../core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md) to prepare for the next editing session. The debugger may then continue the process. - Whenever the debugger calls `ApplyChanges` on a module that has delta metadata, it should also call [IMetaDataEmit::ApplyEditAndContinue](../metadata/imetadataemit-applyeditandcontinue-method.md) with the same delta metadata on all of its copies of that module’s metadata except for the copy used to emit the changes. If a copy of the metadata somehow becomes out-of-sync with the actual metadata, the debugger can always throw away that copy and obtain a new copy. + Whenever the debugger calls `ApplyChanges` on a module that has delta metadata, it should also call [IMetaDataEmit::ApplyEditAndContinue](../../../core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md) with the same delta metadata on all of its copies of that module’s metadata except for the copy used to emit the changes. If a copy of the metadata somehow becomes out-of-sync with the actual metadata, the debugger can always throw away that copy and obtain a new copy. If the `ApplyChanges` method fails, the debug session is in an invalid state and must be restarted. diff --git a/docs/framework/unmanaged-api/debugging/icordebugprocess6-enablevirtualmodulesplitting-method.md b/docs/framework/unmanaged-api/debugging/icordebugprocess6-enablevirtualmodulesplitting-method.md index 7acf170941ab2..60c8e75292ef7 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugprocess6-enablevirtualmodulesplitting-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugprocess6-enablevirtualmodulesplitting-method.md @@ -28,7 +28,7 @@ HRESULT EnableVirtualModuleSplitting( > [!NOTE] > This method is available with .NET Native only. - This method can be called and the value of `enableSplitting` can be changed at any time. It does not cause any stateful functional changes in an [ICorDebug](icordebug-interface.md) object, other than altering the behavior of the methods listed in the [Virtual module splitting and the unmanaged debugging APIs](#APIs) section at the time they are called. Using virtual modules does incur a performance penalty when calling those methods. In addition, significant in-memory caching of the virtualized metadata may be required to correctly implement the [IMetaDataImport](../metadata/imetadataimport-interface.md) APIs, and these caches may be retained even after virtual module splitting has been turned off. + This method can be called and the value of `enableSplitting` can be changed at any time. It does not cause any stateful functional changes in an [ICorDebug](icordebug-interface.md) object, other than altering the behavior of the methods listed in the [Virtual module splitting and the unmanaged debugging APIs](#APIs) section at the time they are called. Using virtual modules does incur a performance penalty when calling those methods. In addition, significant in-memory caching of the virtualized metadata may be required to correctly implement the [IMetaDataImport](../../../core/unmanaged-api/metadata/imetadataimport-interface.md) APIs, and these caches may be retained even after virtual module splitting has been turned off. ## Terminology @@ -103,7 +103,7 @@ HRESULT EnableVirtualModuleSplitting( |[ICorDebugClass::GetModule](icordebugclass-getmodule-method.md)|Returns the sub-module this class was originally defined in.|Returns the container module this class was merged into.| |ICorDebugModuleDebugEvent::GetModule|Returns the container module that was loaded. Sub-modules are not given load events regardless of this setting.|Returns the container module that was loaded.| |[ICorDebugAppDomain::EnumerateAssemblies](icordebugappdomain-enumerateassemblies-method.md)|Returns a list of sub-assemblies and regular assemblies; no container assemblies are included. **Note:** If any container assembly is missing symbols, none of its sub-assemblies will be enumerated. If any regular assembly is missing symbols, it may or may not be enumerated.|Returns a list of container assemblies and regular assemblies; no sub-assemblies are included. **Note:** If any regular assembly is missing symbols, it may or may not be enumerated.| -|[ICorDebugCode::GetCode](icordebugcode-getcode-method.md) (when referring to IL code only)|Returns IL that would be valid in a pre-merge assembly image. Specifically, any inline metadata tokens will correctly be TypeRef or MemberRef tokens when the types being referred to are not defined in the virtual module containing the IL. These TypeRef or MemberRef tokens can be looked up in the [IMetaDataImport](../metadata/imetadataimport-interface.md) object for the corresponding virtual ICorDebugModule object.|Returns the IL in the post-merge assembly image.| +|[ICorDebugCode::GetCode](icordebugcode-getcode-method.md) (when referring to IL code only)|Returns IL that would be valid in a pre-merge assembly image. Specifically, any inline metadata tokens will correctly be TypeRef or MemberRef tokens when the types being referred to are not defined in the virtual module containing the IL. These TypeRef or MemberRef tokens can be looked up in the [IMetaDataImport](../../../core/unmanaged-api/metadata/imetadataimport-interface.md) object for the corresponding virtual ICorDebugModule object.|Returns the IL in the post-merge assembly image.| ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/ixclrdatatypedefinition-getcorelementtype-method.md b/docs/framework/unmanaged-api/debugging/ixclrdatatypedefinition-getcorelementtype-method.md index 378dca57819ad..85c3a04b47eb3 100644 --- a/docs/framework/unmanaged-api/debugging/ixclrdatatypedefinition-getcorelementtype-method.md +++ b/docs/framework/unmanaged-api/debugging/ixclrdatatypedefinition-getcorelementtype-method.md @@ -51,4 +51,4 @@ The provided method is part of the `IXCLRDataTypeDefinition` interface and corre - [Debugging](index.md) - [IXCLRDataTypeDefinition Interface](ixclrdatatypedefinition-interface.md) -- [CorElementType Enumeration](../metadata/corelementtype-enumeration.md) +- [CorElementType Enumeration](../../../core/unmanaged-api/metadata/corelementtype-enumeration.md) diff --git a/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md b/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md index c44b17e3cdf88..525a5c939dada 100644 --- a/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md +++ b/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md @@ -2,53 +2,49 @@ description: "Learn more about: CoEEShutDownCOM Function" title: "CoEEShutDownCOM Function" ms.date: "03/30/2017" -api_name: +api_name: - "CoEEShutDownCOM" -api_location: +api_location: - "mscoree.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" - "mscorsvr.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CoEEShutDownCOM" -helpviewer_keywords: +helpviewer_keywords: - "CoEEShutDownCOM function [.NET Framework hosting]" ms.assetid: b634cae2-632f-4737-9be4-92d0652844d7 -topic_type: +topic_type: - "apiref" --- # CoEEShutDownCOM Function -Forces the common language runtime (CLR) to release all interface pointers it holds inside runtime callable wrappers (RCW). This has the effect of releasing all RCW caches. This global function is deprecated in the .NET Framework 4. Instead, use the entry point for a specific runtime. - -## Syntax - -```cpp -void CoEEShutDownCOM (); -``` - -## Remarks - - The `CoEEShutDownCOM` function first releases all the RCWs in all contexts and in all caches, and then removes any tear-down notification existing in setup. No DLL unloading occurs. - +Forces the common language runtime (CLR) to release all interface pointers it holds inside runtime callable wrappers (RCW). This has the effect of releasing all RCW caches. This global function is deprecated in the .NET Framework 4. Instead, use the entry point for a specific runtime. + +## Syntax + +```cpp +void CoEEShutDownCOM (); +``` + +## Remarks + + The `CoEEShutDownCOM` function first releases all the RCWs in all contexts and in all caches, and then removes any tear-down notification existing in setup. No DLL unloading occurs. + > [!CAUTION] -> This function affects all runtimes that are loaded into the process. - - Beginning with the .NET Framework 4, call the entry point for this function on the specific runtime you want to affect. To get the entry point, call the [ICLRRuntimeInfo::GetProcAddress](iclrruntimeinfo-getprocaddress-method.md) method and specify "CoEEShutDownCOM". - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) +> This function affects all runtimes that are loaded into the process. + + Beginning with the .NET Framework 4, call the entry point for this function on the specific runtime you want to affect. To get the entry point, call the [ICLRRuntimeInfo::GetProcAddress](iclrruntimeinfo-getprocaddress-method.md) method and specify "CoEEShutDownCOM". + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] diff --git a/docs/framework/unmanaged-api/hosting/coinitializecor-function.md b/docs/framework/unmanaged-api/hosting/coinitializecor-function.md index f48cf805b3d79..fc9cbba7853a7 100644 --- a/docs/framework/unmanaged-api/hosting/coinitializecor-function.md +++ b/docs/framework/unmanaged-api/hosting/coinitializecor-function.md @@ -2,41 +2,37 @@ description: "Learn more about: CoInitializeCor Function" title: "CoInitializeCor Function" ms.date: "03/30/2017" -api_name: +api_name: - "CoInitializeCor" -api_location: +api_location: - "mscoree.dll" - "mscorsvr.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CoInitializeCor" -helpviewer_keywords: +helpviewer_keywords: - "CoInitializeCor function [.NET Framework hosting]" ms.assetid: 9b9079fb-579e-4141-b3f0-791072dd40dc -topic_type: +topic_type: - "apiref" --- # CoInitializeCor Function -`CoInitializeCor` is obsolete. - -## Syntax - -```cpp -STDAPI CoInitializeCor ( - DWORD fFlags -); -``` - -## Remarks +`CoInitializeCor` is obsolete. - To initialize the common language runtime, use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). - -## Requirements +## Syntax - **Header:** Cor.h - -## See also +```cpp +STDAPI CoInitializeCor ( + DWORD fFlags +); +``` -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) +## Remarks + + To initialize the common language runtime, use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). + +## Requirements + + **Header:** Cor.h diff --git a/docs/framework/unmanaged-api/hosting/coinitializeee-function.md b/docs/framework/unmanaged-api/hosting/coinitializeee-function.md index a862de2ae0256..23accef892f40 100644 --- a/docs/framework/unmanaged-api/hosting/coinitializeee-function.md +++ b/docs/framework/unmanaged-api/hosting/coinitializeee-function.md @@ -2,62 +2,58 @@ description: "Learn more about: CoInitializeEE Function" title: "CoInitializeEE Function" ms.date: "03/30/2017" -api_name: +api_name: - "CoInitializeEE" -api_location: +api_location: - "mscoree.dll" - "mscorsvr.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CoInitializeEE" -helpviewer_keywords: +helpviewer_keywords: - "CoInitializeEE function [.NET Framework hosting]" ms.assetid: 7e42a928-5068-4ba6-b8c3-806551a01fa8 -topic_type: +topic_type: - "apiref" --- # CoInitializeEE Function -Ensures that the common language runtime execution engine is loaded into a process. This function is deprecated in the .NET Framework 4. Use the [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md) method instead. - -## Syntax - -```cpp -HRESULT CoInitializeEE ( - [in] DWORD fFlags -); -``` - -## Parameters - - `fFlags` - [in] One of the [COINITIEE](../metadata/coinitiee-enumeration.md) enumeration constants. - -## Return Value - - This method returns standard COM error codes as defined in Winerror.h, and the values in the following table. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The execution engine was loaded successfully.| -|S_FALSE|The execution engine is already loaded.| -|E_FAIL|The execution engine could not be loaded.| - -## Remarks - - This method loads the execution engine if it has not been previously loaded. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) +Ensures that the common language runtime execution engine is loaded into a process. This function is deprecated in the .NET Framework 4. Use the [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md) method instead. + +## Syntax + +```cpp +HRESULT CoInitializeEE ( + [in] DWORD fFlags +); +``` + +## Parameters + + `fFlags` + [in] One of the [COINITIEE](../../../core/unmanaged-api/metadata/coinitiee-enumeration.md) enumeration constants. + +## Return Value + + This method returns standard COM error codes as defined in Winerror.h, and the values in the following table. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The execution engine was loaded successfully.| +|S_FALSE|The execution engine is already loaded.| +|E_FAIL|The execution engine could not be loaded.| + +## Remarks + + This method loads the execution engine if it has not been previously loaded. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] diff --git a/docs/framework/unmanaged-api/hosting/cordllmain-function.md b/docs/framework/unmanaged-api/hosting/cordllmain-function.md index 9a329189ad375..b8a55302638e7 100644 --- a/docs/framework/unmanaged-api/hosting/cordllmain-function.md +++ b/docs/framework/unmanaged-api/hosting/cordllmain-function.md @@ -2,69 +2,65 @@ description: "Learn more about: _CorDllMain Function" title: "_CorDllMain Function" ms.date: "03/30/2017" -api_name: +api_name: - "_CorDllMain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "_CorDllMain" -helpviewer_keywords: +helpviewer_keywords: - "_CorDllMain function [.NET Framework hosting]" ms.assetid: bc7b51cf-39d3-48ec-a5cb-2f179fbefff8 -topic_type: +topic_type: - "apiref" --- # \_CorDllMain Function -Initializes the common language runtime (CLR), locates the managed entry point in the DLL assembly's CLR header, and begins execution. - -## Syntax - -```cpp -BOOL STDMETHODCALLTYPE _CorDllMain ( - [in] HINSTANCE hInst, - [in] DWORD dwReason, - [in] LPVOID lpReserved -); -``` - -## Parameters - - `hInst` - [in] The instance handle of the loaded module. - - `dwReason` - [in]Indicates why the DLL entry-point function is being called. This parameter can be one of the following values: DLL\_PROCESS_ATTACH, DLL\_THREAD\_ATTACH, DLL\_THREAD\_ATTACH, or DLL\_PROCESS\_DETACH. For descriptions of these values, see the `DllMain` documentation in the Platform SDK. - - `lpReserved` - [in] Unused. - -## Return Value - - This method returns `true` for success and `false` if an error occurs. - -## Remarks - - This function is called by the operating system loader for DLL assemblies. For executable assemblies, the loader calls the [\_CorExeMain](corexemain-function.md) function instead. - - The operating system loader calls this method regardless of the entry point specified in the DLL file. - +Initializes the common language runtime (CLR), locates the managed entry point in the DLL assembly's CLR header, and begins execution. + +## Syntax + +```cpp +BOOL STDMETHODCALLTYPE _CorDllMain ( + [in] HINSTANCE hInst, + [in] DWORD dwReason, + [in] LPVOID lpReserved +); +``` + +## Parameters + + `hInst` + [in] The instance handle of the loaded module. + + `dwReason` + [in]Indicates why the DLL entry-point function is being called. This parameter can be one of the following values: DLL\_PROCESS_ATTACH, DLL\_THREAD\_ATTACH, DLL\_THREAD\_ATTACH, or DLL\_PROCESS\_DETACH. For descriptions of these values, see the `DllMain` documentation in the Platform SDK. + + `lpReserved` + [in] Unused. + +## Return Value + + This method returns `true` for success and `false` if an error occurs. + +## Remarks + + This function is called by the operating system loader for DLL assemblies. For executable assemblies, the loader calls the [\_CorExeMain](corexemain-function.md) function instead. + + The operating system loader calls this method regardless of the entry point specified in the DLL file. + The `_CorDllMain` function is called directly by the operating system loader. - - For additional information, see the Remarks section in the [\_CorValidateImage](corvalidateimage-function.md) topic. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) + + For additional information, see the Remarks section in the [\_CorValidateImage](corvalidateimage-function.md) topic. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] diff --git a/docs/framework/unmanaged-api/hosting/corexemain-function.md b/docs/framework/unmanaged-api/hosting/corexemain-function.md index 708c87a9e02a7..42a82de85b994 100644 --- a/docs/framework/unmanaged-api/hosting/corexemain-function.md +++ b/docs/framework/unmanaged-api/hosting/corexemain-function.md @@ -2,51 +2,47 @@ description: "Learn more about: _CorExeMain Function" title: "_CorExeMain Function" ms.date: "03/30/2017" -api_name: +api_name: - "_CorExeMain" -api_location: +api_location: - "mscoree.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "_CorExeMain" -helpviewer_keywords: +helpviewer_keywords: - "_CorExeMain function [.NET Framework hosting]" ms.assetid: 898f76e2-16f4-4a63-b7d9-dad2d3824d8a -topic_type: +topic_type: - "apiref" --- # _CorExeMain Function -Initializes the common language runtime (CLR), locates the managed entry point in the executable assembly's CLR header, and begins execution. - -## Syntax - -```cpp -__int32 STDMETHODCALLTYPE _CorExeMain (); -``` - -## Remarks - - This function is called by the loader in processes created from managed executable assemblies. For DLL assemblies, the loader calls the [_CorDllMain](cordllmain-function.md) function instead. - +Initializes the common language runtime (CLR), locates the managed entry point in the executable assembly's CLR header, and begins execution. + +## Syntax + +```cpp +__int32 STDMETHODCALLTYPE _CorExeMain (); +``` + +## Remarks + + This function is called by the loader in processes created from managed executable assemblies. For DLL assemblies, the loader calls the [_CorDllMain](cordllmain-function.md) function instead. + The operating system loader calls this method regardless of the entry point specified in the image file. - - For additional information, see the Remarks section in the [_CorValidateImage](corvalidateimage-function.md) article. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) + + For additional information, see the Remarks section in the [_CorValidateImage](corvalidateimage-function.md) article. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] diff --git a/docs/framework/unmanaged-api/hosting/corexemain2-function.md b/docs/framework/unmanaged-api/hosting/corexemain2-function.md index fc3bd53e240bd..12f4583535cb0 100644 --- a/docs/framework/unmanaged-api/hosting/corexemain2-function.md +++ b/docs/framework/unmanaged-api/hosting/corexemain2-function.md @@ -2,63 +2,59 @@ description: "Learn more about: _CorExeMain2 Function" title: "_CorExeMain2 Function" ms.date: "03/30/2017" -api_name: +api_name: - "_CorExeMain2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "_CorExeMain2" -helpviewer_keywords: +helpviewer_keywords: - "_CorExeMain2 function [.NET Framework hosting]" ms.assetid: 72ea68b4-689f-4733-9416-9664b75e8892 -topic_type: +topic_type: - "apiref" --- # _CorExeMain2 Function -Executes the entry point in the specified memory-mapped code. This function is called by the operating system loader. - -## Syntax - -```cpp -__int32 STDMETHODCALLTYPE _CorExeMain2 ( - [in] PBYTE pUnmappedPE, - [in] DWORD cUnmappedPE, - [in] __in LPWSTR pImageNameIn, - [in] __in LPWSTR pLoadersFileName, - [in] __in LPWSTR pCmdLine -); -``` - -## Parameters +Executes the entry point in the specified memory-mapped code. This function is called by the operating system loader. - `pUnmappedPE` - [in] A pointer to the memory-mapped code. - - `cUnmappedPE` - [in] The number of elements `pUnmappedPE` can hold. - - `pImageNameIn` - [in] A pointer to the name of the executable image. - - `pLoadersFileName` - [in] The name of the loader file. - - `pCmdLine` - [in] Command-line parameters, if any. - -## Requirements +## Syntax - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also +```cpp +__int32 STDMETHODCALLTYPE _CorExeMain2 ( + [in] PBYTE pUnmappedPE, + [in] DWORD cUnmappedPE, + [in] __in LPWSTR pImageNameIn, + [in] __in LPWSTR pLoadersFileName, + [in] __in LPWSTR pCmdLine +); +``` -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) +## Parameters + + `pUnmappedPE` + [in] A pointer to the memory-mapped code. + + `cUnmappedPE` + [in] The number of elements `pUnmappedPE` can hold. + + `pImageNameIn` + [in] A pointer to the name of the executable image. + + `pLoadersFileName` + [in] The name of the loader file. + + `pCmdLine` + [in] Command-line parameters, if any. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] diff --git a/docs/framework/unmanaged-api/hosting/corimageunloading-function.md b/docs/framework/unmanaged-api/hosting/corimageunloading-function.md index 23492f385aa43..80cdc92f3dced 100644 --- a/docs/framework/unmanaged-api/hosting/corimageunloading-function.md +++ b/docs/framework/unmanaged-api/hosting/corimageunloading-function.md @@ -2,49 +2,45 @@ description: "Learn more about: _CorImageUnloading Function" title: "_CorImageUnloading Function" ms.date: "03/30/2017" -api_name: +api_name: - "_CorImageUnloading" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "_CorImageUnloading" -helpviewer_keywords: +helpviewer_keywords: - "_CorImageUnloading function [.NET Framework hosting]" ms.assetid: b4367214-6dac-4280-aa11-fd487ff30bc4 -topic_type: +topic_type: - "apiref" --- # _CorImageUnloading Function -Notifies the loader when the managed module images are unloaded. - - This function is not implemented. If called, it returns E_NOTIMPL. - -## Syntax - -```cpp +Notifies the loader when the managed module images are unloaded. + + This function is not implemented. If called, it returns E_NOTIMPL. + +## Syntax + +```cpp STDAPI (VOID) _CorImageUnloading( - [in] PVOID* ImageBase -); -``` - -## Parameters - - `ImageBase` - [in] A pointer to the starting location of the image to unload. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) + [in] PVOID* ImageBase +); +``` + +## Parameters + + `ImageBase` + [in] A pointer to the starting location of the image to unload. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] diff --git a/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md b/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md index c2b91d387f4bc..8504a343a78a9 100644 --- a/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md +++ b/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md @@ -2,84 +2,80 @@ description: "Learn more about: _CorValidateImage Function" title: "_CorValidateImage Function" ms.date: "03/30/2017" -api_name: +api_name: - "_CorValidateImage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "_CorValidateImage" -helpviewer_keywords: +helpviewer_keywords: - "_CorValidateImage function [.NET Framework hosting]" ms.assetid: 0117e080-05f9-4772-885d-e1847230947c -topic_type: +topic_type: - "apiref" --- # _CorValidateImage Function -Validates managed module images, and notifies the operating system loader after they have been loaded. - -## Syntax - -```cpp +Validates managed module images, and notifies the operating system loader after they have been loaded. + +## Syntax + +```cpp STDAPI _CorValidateImage ( - [in] PVOID* ImageBase, - [in] LPCWSTR FileName -); -``` - -## Parameters - - `ImageBase` - [in] A pointer to the starting location of the image to validate as managed code. The image must already be loaded into memory. - - `FileName` - [in] The file name of the image. - -## Return Value - - This function returns the standard values `E_INVALIDARG`, `E_OUTOFMEMORY`, `E_UNEXPECTED`, and `E_FAIL`, as well as the following values. - -|Return value|Description| -|------------------|-----------------| -|`STATUS_INVALID_IMAGE_FORMAT`|The image is invalid. This value has the HRESULT 0xC000007BL.| -|`STATUS_SUCCESS`|The image is valid. This value has the HRESULT 0x00000000L.| - -## Remarks - - In Windows XP and later versions, the operating system loader checks for managed modules by examining the COM Descriptor Directory bit in the common object file format (COFF) header. A set bit indicates a managed module. If the loader detects a managed module, it loads MsCorEE.dll and calls `_CorValidateImage`, which performs the following actions: - -- Confirms that the image is a valid managed module. - -- Changes the entry point in the image to an entry point in the common language runtime (CLR). - -- For 64-bit versions of Windows, modifies the image that is in memory by transforming it from PE32 to PE32+ format. - -- Returns to the loader when the managed module images are loaded. - - For executable images, the operating system loader then calls the [_CorExeMain](corexemain-function.md) function, regardless of the entry point specified in the executable. For DLL assembly images, the loader calls the [_CorDllMain](cordllmain-function.md) function. - - `_CorExeMain` or `_CorDllMain` performs the following actions: - -- Initializes the CLR. - -- Locates the managed entry point from the assembly's CLR header. - -- Begins execution. - - The loader calls the [_CorImageUnloading](corimageunloading-function.md) function when managed module images are unloaded. However, this function does not perform any action; it just returns. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) + [in] PVOID* ImageBase, + [in] LPCWSTR FileName +); +``` + +## Parameters + + `ImageBase` + [in] A pointer to the starting location of the image to validate as managed code. The image must already be loaded into memory. + + `FileName` + [in] The file name of the image. + +## Return Value + + This function returns the standard values `E_INVALIDARG`, `E_OUTOFMEMORY`, `E_UNEXPECTED`, and `E_FAIL`, as well as the following values. + +|Return value|Description| +|------------------|-----------------| +|`STATUS_INVALID_IMAGE_FORMAT`|The image is invalid. This value has the HRESULT 0xC000007BL.| +|`STATUS_SUCCESS`|The image is valid. This value has the HRESULT 0x00000000L.| + +## Remarks + + In Windows XP and later versions, the operating system loader checks for managed modules by examining the COM Descriptor Directory bit in the common object file format (COFF) header. A set bit indicates a managed module. If the loader detects a managed module, it loads MsCorEE.dll and calls `_CorValidateImage`, which performs the following actions: + +- Confirms that the image is a valid managed module. + +- Changes the entry point in the image to an entry point in the common language runtime (CLR). + +- For 64-bit versions of Windows, modifies the image that is in memory by transforming it from PE32 to PE32+ format. + +- Returns to the loader when the managed module images are loaded. + + For executable images, the operating system loader then calls the [_CorExeMain](corexemain-function.md) function, regardless of the entry point specified in the executable. For DLL assembly images, the loader calls the [_CorDllMain](cordllmain-function.md) function. + + `_CorExeMain` or `_CorDllMain` performs the following actions: + +- Initializes the CLR. + +- Locates the managed entry point from the assembly's CLR header. + +- Begins execution. + + The loader calls the [_CorImageUnloading](corimageunloading-function.md) function when managed module images are unloaded. However, this function does not perform any action; it just returns. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** Cor.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] diff --git a/docs/framework/unmanaged-api/hosting/couninitializecor-function.md b/docs/framework/unmanaged-api/hosting/couninitializecor-function.md index b491716f17953..b9636f83320ea 100644 --- a/docs/framework/unmanaged-api/hosting/couninitializecor-function.md +++ b/docs/framework/unmanaged-api/hosting/couninitializecor-function.md @@ -2,35 +2,31 @@ description: "Learn more about: CoUninitializeCor Function" title: "CoUninitializeCor Function" ms.date: "03/30/2017" -api_name: +api_name: - "CoUninitializeCor" -api_location: +api_location: - "mscoree.dll" - "mscorsvr.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CoUninitializeCor" -helpviewer_keywords: +helpviewer_keywords: - "CoUninitializeCor function [.NET Framework hosting]" ms.assetid: 50a95b8b-9766-470e-bb29-2c7ecddfd4a1 -topic_type: +topic_type: - "apiref" --- # CoUninitializeCor Function -`CoUninitializeCor` is obsolete. - -## Syntax - -```cpp -STDAPI_(void) CoUninitializeCor(void); -``` - -## Remarks +`CoUninitializeCor` is obsolete. - The common language runtime cannot be unloaded from a process. To completely remove the runtime from a running process, you must shut down that process. - -## See also +## Syntax -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) +```cpp +STDAPI_(void) CoUninitializeCor(void); +``` + +## Remarks + + The common language runtime cannot be unloaded from a process. To completely remove the runtime from a running process, you must shut down that process. diff --git a/docs/framework/unmanaged-api/hosting/couninitializeee-function.md b/docs/framework/unmanaged-api/hosting/couninitializeee-function.md index ff8f0ed97ccf6..301980921d013 100644 --- a/docs/framework/unmanaged-api/hosting/couninitializeee-function.md +++ b/docs/framework/unmanaged-api/hosting/couninitializeee-function.md @@ -2,38 +2,37 @@ description: "Learn more about: CoUninitializeEE Function" title: "CoUninitializeEE Function" ms.date: "03/30/2017" -api_name: +api_name: - "CoUninitializeEE" -api_location: +api_location: - "mscoree.dll" - "mscorsvr.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CoUninitializeEE" -helpviewer_keywords: +helpviewer_keywords: - "CoUninitializeEE function [.NET Framework hosting]" ms.assetid: 5f5a311a-839a-465f-89d9-ff1c74da9736 -topic_type: +topic_type: - "apiref" --- # CoUninitializeEE Function -`CoUninitializeEE` is obsolete and provides no functionality. - -## Syntax - -```cpp -void CoUninitializeEE ( - BOOL fFlags -); -``` - -## Remarks +`CoUninitializeEE` is obsolete and provides no functionality. + +## Syntax + +```cpp +void CoUninitializeEE ( + BOOL fFlags +); +``` + +## Remarks + + The common language runtime execution engine cannot be unloaded from a process. To shut down the execution engine call [CorExitProcess](corexitprocess-function.md). - The common language runtime execution engine cannot be unloaded from a process. To shut down the execution engine call [CorExitProcess](corexitprocess-function.md). - ## See also - [CoInitializeEE Function](coinitializeee-function.md) -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md index a08755177023a..3f33fafb2fe1f 100644 --- a/docs/framework/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md @@ -2,64 +2,64 @@ description: "Learn more about: ICLRRuntimeHost::SetHostControl Method" title: "ICLRRuntimeHost::SetHostControl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.SetHostControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::SetHostControl" -helpviewer_keywords: +helpviewer_keywords: - "SetHostControl method [.NET Framework hosting]" - "ICLRRuntimeHost::SetHostControl method [.NET Framework hosting]" ms.assetid: 6136be87-e631-4756-81ed-74b66581bad4 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost::SetHostControl Method -Sets the interface pointer that the common language runtime (CLR) can use to get the host's implementation of [IHostControl Interface](ihostcontrol-interface.md). - -## Syntax - -```cpp -HRESULT SetHostControl( - [in] IHostControl* pHostControl -); -``` - -## Parameters - - `pHostControl` - [in] An interface pointer to the host's implementation of [IHostControl Interface](ihostcontrol-interface.md). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetHostControl` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The CLR has not been loaded into a process, or the CLR is in a state in which it cannot run managed code or process the call successfully.| -|HOST_E_TIMEOUT|The call timed out.| -|HOST_E_NOT_OWNER|The caller does not own the lock.| -|HOST_E_ABANDONED|An event was canceled while a blocked thread or fiber was waiting on it.| -|E_FAIL|An unknown catastrophic failure occurred. If a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_CLR_ALREADY_STARTED|The CLR has already been initialized.| - -## Remarks - - You must call `SetHostControl` before the CLR is initialized, that is, before you call [Start Method](iclrruntimehost-start-method.md) or use any of the [Metadata Interfaces](../metadata/metadata-interfaces.md). It is recommended that you call `SetHostControl` immediately after calling [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) or [CorBindToRuntimeEx Function](corbindtoruntimeex-function.md). - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Sets the interface pointer that the common language runtime (CLR) can use to get the host's implementation of [IHostControl Interface](ihostcontrol-interface.md). + +## Syntax + +```cpp +HRESULT SetHostControl( + [in] IHostControl* pHostControl +); +``` + +## Parameters + + `pHostControl` + [in] An interface pointer to the host's implementation of [IHostControl Interface](ihostcontrol-interface.md). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetHostControl` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The CLR has not been loaded into a process, or the CLR is in a state in which it cannot run managed code or process the call successfully.| +|HOST_E_TIMEOUT|The call timed out.| +|HOST_E_NOT_OWNER|The caller does not own the lock.| +|HOST_E_ABANDONED|An event was canceled while a blocked thread or fiber was waiting on it.| +|E_FAIL|An unknown catastrophic failure occurred. If a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_CLR_ALREADY_STARTED|The CLR has already been initialized.| + +## Remarks + + You must call `SetHostControl` before the CLR is initialized, that is, before you call [Start Method](iclrruntimehost-start-method.md) or use any of the [Metadata Interfaces](../../../core/unmanaged-api/metadata/metadata-interfaces.md). It is recommended that you call `SetHostControl` immediately after calling [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) or [CorBindToRuntimeEx Function](corbindtoruntimeex-function.md). + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md index ebde545d9275e..a6693e427da32 100644 --- a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md @@ -2,84 +2,84 @@ description: "Learn more about: ICLRRuntimeInfo::GetInterface Method" title: "ICLRRuntimeInfo::GetInterface Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.GetInterface" -api_location: +api_location: - "mscordbi.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::GetInterface" -helpviewer_keywords: +helpviewer_keywords: - "GetInterface method [.NET Framework hosting]" - "ICLRRuntimeInfo::GetInterface method [.NET Framework hosting]" ms.assetid: cc7b0e5b-48c3-4509-8ebb-611ddb1f7ec2 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::GetInterface Method -Loads the CLR into the current process and returns runtime interface pointers, such as [ICLRRuntimeHost](iclrruntimehost-interface.md), [ICLRStrongName](iclrstrongname-interface.md), and [IMetaDataDispenserEx](../metadata/imetadatadispenser-interface.md). - - This method supersedes all the `CorBindTo`* functions in the [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) section. - -## Syntax - -```cpp -HRESULT GetInterface( -[in] REFCLSID rclsid, -[in] REFIID riid, -[out, iid_is(riid), retval] LPVOID *ppUnk); -``` - -## Parameters - - `rclsid` - [in] The CLSID interface for the coclass. - - `riid` - [in] The IID of the requested `rclsid` interface. - - `ppUnk` - [out] A pointer to the queried interface. - -## Return Value - - This method returns the following specific HRESULTs as well as HRESULT errors that indicate method failure. - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method completed successfully.| -|E_POINTER|`ppUnk` is null.| -|E_OUTOFMEMORY|Not enough memory is available to handle the request.| -|CLR_E_SHIM_LEGACYRUNTIMEALREADYBOUND|A different runtime was already bound to the legacy CLR version 2 activation policy.| - -## Remarks - - This method causes the CLR to be loaded but not initialized. - - The following table shows the supported combinations for `rclsid` and `riid`. - -|`rclsid`|`riid`| -|--------------|------------| -|CLSID_CorMetaDataDispenser|IID_IMetaDataDispenser, IID_IMetaDataDispenserEx| -|CLSID_CorMetaDataDispenserRuntime|IID_IMetaDataDispenser, IID_IMetaDataDispenserEx| -|CLSID_CorRuntimeHost|IID_ICorRuntimeHost| -|CLSID_CLRRuntimeHost|IID_ICLRRuntimeHost| -|CLSID_TypeNameFactory|IID_ITypeNameFactory| +Loads the CLR into the current process and returns runtime interface pointers, such as [ICLRRuntimeHost](iclrruntimehost-interface.md), [ICLRStrongName](iclrstrongname-interface.md), and [IMetaDataDispenserEx](../../../core/unmanaged-api/metadata/imetadatadispenser-interface.md). + + This method supersedes all the `CorBindTo`* functions in the [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) section. + +## Syntax + +```cpp +HRESULT GetInterface( +[in] REFCLSID rclsid, +[in] REFIID riid, +[out, iid_is(riid), retval] LPVOID *ppUnk); +``` + +## Parameters + + `rclsid` + [in] The CLSID interface for the coclass. + + `riid` + [in] The IID of the requested `rclsid` interface. + + `ppUnk` + [out] A pointer to the queried interface. + +## Return Value + + This method returns the following specific HRESULTs as well as HRESULT errors that indicate method failure. + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method completed successfully.| +|E_POINTER|`ppUnk` is null.| +|E_OUTOFMEMORY|Not enough memory is available to handle the request.| +|CLR_E_SHIM_LEGACYRUNTIMEALREADYBOUND|A different runtime was already bound to the legacy CLR version 2 activation policy.| + +## Remarks + + This method causes the CLR to be loaded but not initialized. + + The following table shows the supported combinations for `rclsid` and `riid`. + +|`rclsid`|`riid`| +|--------------|------------| +|CLSID_CorMetaDataDispenser|IID_IMetaDataDispenser, IID_IMetaDataDispenserEx| +|CLSID_CorMetaDataDispenserRuntime|IID_IMetaDataDispenser, IID_IMetaDataDispenserEx| +|CLSID_CorRuntimeHost|IID_ICorRuntimeHost| +|CLSID_CLRRuntimeHost|IID_ICLRRuntimeHost| +|CLSID_TypeNameFactory|IID_ITypeNameFactory| |CLSID_CLRDebuggingLegacy|IID_ICorDebug| -|CLSID_CLRStrongName|IID_ICLRStrongName| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +|CLSID_CLRStrongName|IID_ICLRStrongName| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-interface.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-interface.md index c874877bbf132..fe491260cf750 100644 --- a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-interface.md @@ -2,51 +2,51 @@ description: "Learn more about: ICLRRuntimeInfo Interface" title: "ICLRRuntimeInfo Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo interface [.NET Framework hosting]" ms.assetid: 287e5ede-b3a7-4ef8-a756-4fca3f285a82 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo Interface -Provides methods that return information about a specific common language runtime (CLR), including version, directory, and load status. This interface also provides runtime-specific functionality without initializing the runtime. It includes the runtime-relative [LoadLibrary](iclrruntimeinfo-loadlibrary-method.md) method, the runtime module-specific [GetProcAddress](iclrruntimeinfo-getprocaddress-method.md) method, and runtime-provided interfaces through the [GetInterface](iclrruntimeinfo-getinterface-method.md) method. - -## Methods - -|Method|Description| -|------------|-----------------| -|[BindAsLegacyV2Runtime Method](iclrruntimeinfo-bindaslegacyv2runtime-method.md)|Binds this runtime for all legacy CLR version 2 activation policy decisions.| -|[GetDefaultStartupFlags Method](iclrruntimeinfo-getdefaultstartupflags-method.md)|Gets the CLR startup flags and host configuration file.| -|[GetInterface Method](iclrruntimeinfo-getinterface-method.md)|Loads the CLR into the current process and returns runtime interface pointers, such as [ICLRRuntimeHost](iclrruntimehost-interface.md), [ICLRStrongName](iclrstrongname-interface.md) and [IMetaDataDispenser](../metadata/imetadatadispenser-interface.md). This method supersedes all the `CorBindTo*` functions.| -|[GetProcAddress Method](iclrruntimeinfo-getprocaddress-method.md)|Gets the address of a specified function that was exported from the CLR associated with this interface. This method supersedes the [GetRealProcAddress](getrealprocaddress-function.md) method.| -|[GetRuntimeDirectory Method](iclrruntimeinfo-getruntimedirectory-method.md)|Gets the installation directory of the CLR associated with this interface. This method supersedes the [GetCORSystemDirectory](getcorsystemdirectory-function.md) method.| -|[GetVersionString Method](iclrruntimeinfo-getversionstring-method.md)|Gets common language runtime (CLR) version information associated with a given [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. This method supersedes the [GetRequestedRuntimeInfo](getrequestedruntimeinfo-function.md) and [GetRequestedRuntimeVersion](getrequestedruntimeversion-function.md) methods.| -|[IsLoadable Method](iclrruntimeinfo-isloadable-method.md)|Indicates whether the runtime associated with this interface can be loaded into the current process, taking into account other runtimes that might already be loaded into the process.| -|[IsLoaded Method](iclrruntimeinfo-isloaded-method.md)|Indicates whether the CLR associated with the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface is loaded into a process.| -|[IsStarted Method](iclrruntimeinfo-isstarted-method.md)|Indicates whether the CLR that is associated with the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface has been started.| -|[LoadErrorString Method](iclrruntimeinfo-loaderrorstring-method.md)|Translates an HRESULT value into an appropriate error message for the specified culture. This method supersedes the [LoadStringRC](loadstringrc-function.md) and [LoadStringRCEx](loadstringrcex-function.md) methods.| -|[LoadLibrary Method](iclrruntimeinfo-loadlibrary-method.md)|Loads a library from the framework directory of the CLR represented by an [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. This method supersedes the [LoadLibraryShim](loadlibraryshim-function.md) method.| -|[SetDefaultStartupFlags Method](iclrruntimeinfo-setdefaultstartupflags-method.md)|Sets the CLR startup flags and host configuration file.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Provides methods that return information about a specific common language runtime (CLR), including version, directory, and load status. This interface also provides runtime-specific functionality without initializing the runtime. It includes the runtime-relative [LoadLibrary](iclrruntimeinfo-loadlibrary-method.md) method, the runtime module-specific [GetProcAddress](iclrruntimeinfo-getprocaddress-method.md) method, and runtime-provided interfaces through the [GetInterface](iclrruntimeinfo-getinterface-method.md) method. + +## Methods + +|Method|Description| +|------------|-----------------| +|[BindAsLegacyV2Runtime Method](iclrruntimeinfo-bindaslegacyv2runtime-method.md)|Binds this runtime for all legacy CLR version 2 activation policy decisions.| +|[GetDefaultStartupFlags Method](iclrruntimeinfo-getdefaultstartupflags-method.md)|Gets the CLR startup flags and host configuration file.| +|[GetInterface Method](iclrruntimeinfo-getinterface-method.md)|Loads the CLR into the current process and returns runtime interface pointers, such as [ICLRRuntimeHost](iclrruntimehost-interface.md), [ICLRStrongName](iclrstrongname-interface.md) and [IMetaDataDispenser](../../../core/unmanaged-api/metadata/imetadatadispenser-interface.md). This method supersedes all the `CorBindTo*` functions.| +|[GetProcAddress Method](iclrruntimeinfo-getprocaddress-method.md)|Gets the address of a specified function that was exported from the CLR associated with this interface. This method supersedes the [GetRealProcAddress](getrealprocaddress-function.md) method.| +|[GetRuntimeDirectory Method](iclrruntimeinfo-getruntimedirectory-method.md)|Gets the installation directory of the CLR associated with this interface. This method supersedes the [GetCORSystemDirectory](getcorsystemdirectory-function.md) method.| +|[GetVersionString Method](iclrruntimeinfo-getversionstring-method.md)|Gets common language runtime (CLR) version information associated with a given [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. This method supersedes the [GetRequestedRuntimeInfo](getrequestedruntimeinfo-function.md) and [GetRequestedRuntimeVersion](getrequestedruntimeversion-function.md) methods.| +|[IsLoadable Method](iclrruntimeinfo-isloadable-method.md)|Indicates whether the runtime associated with this interface can be loaded into the current process, taking into account other runtimes that might already be loaded into the process.| +|[IsLoaded Method](iclrruntimeinfo-isloaded-method.md)|Indicates whether the CLR associated with the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface is loaded into a process.| +|[IsStarted Method](iclrruntimeinfo-isstarted-method.md)|Indicates whether the CLR that is associated with the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface has been started.| +|[LoadErrorString Method](iclrruntimeinfo-loaderrorstring-method.md)|Translates an HRESULT value into an appropriate error message for the specified culture. This method supersedes the [LoadStringRC](loadstringrc-function.md) and [LoadStringRCEx](loadstringrcex-function.md) methods.| +|[LoadLibrary Method](iclrruntimeinfo-loadlibrary-method.md)|Loads a library from the framework directory of the CLR represented by an [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. This method supersedes the [LoadLibraryShim](loadlibraryshim-function.md) method.| +|[SetDefaultStartupFlags Method](iclrruntimeinfo-setdefaultstartupflags-method.md)|Sets the CLR startup flags and host configuration file.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/index.md b/docs/framework/unmanaged-api/index.md index eebc1dd6b19cf..0b59fccdca7cd 100644 --- a/docs/framework/unmanaged-api/index.md +++ b/docs/framework/unmanaged-api/index.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: Unmanaged API Reference" -title: "Unmanaged API Reference" +description: "Learn more about: .NET Framework unmanaged API reference" +title: ".NET Framework unmanaged API reference" ms.date: "11/06/2017" helpviewer_keywords: - "runtime, unmanaged APIs" @@ -9,50 +9,46 @@ helpviewer_keywords: - "unmanaged API reference [.NET Framework]" ms.assetid: 9aa000ee-c04c-492c-ae4f-83ecdf4fdbbe --- -# Unmanaged API Reference +# .NET Framework unmanaged API reference This section includes information on unmanaged APIs that can be used by managed-code-related applications, such as runtime hosts, compilers, disassemblers, obfuscators, debuggers, and profilers. -## In This Section +For unmanaged APIs that can be used with both .NET Framework and .NET, see [.NET unmanaged API reference](../../core/unmanaged-api/index.md). - [Common Data Types](common-data-types-unmanaged-api-reference.md) +## In this section + + [Common Data Types](common-data-types-unmanaged-api-reference.md)\ Lists the common data types that are used, particularly in the unmanaged profiling and debugging APIs. - [ALink](./alink/index.md) + [ALink](./alink/index.md)\ Describes the ALink API, which supports the creation of .NET Framework assemblies and unbound modules. - [Authenticode](./authenticode/index.md) + [Authenticode](./authenticode/index.md)\ Supports the Authenticode XrML license creation and verification module. - [Constants](constants-unmanaged-api-reference.md) + [Constants](constants-unmanaged-api-reference.md)\ Describes the constants that are defined in CorSym.idl. - [Custom Interface Attributes](/previous-versions/dotnet/netframework-4.0/ms231946(v=vs.100)) - Describes component object model (COM) custom interface attributes. - - [Debugging](./debugging/index.md) + [Debugging](./debugging/index.md)\ Describes the debugging API, which enables a debugger to debug code that runs in the common language runtime (CLR) environment. - [Diagnostics Symbol Store](./diagnostics/index.md) + [Diagnostics Symbol Store](./diagnostics/index.md)\ Describes the diagnostics symbol store API, which enables a compiler to generate symbol information for use by a debugger. - [Fusion](./fusion/index.md) + [Fusion](./fusion/index.md)\ Describes the fusion API, which enables a runtime host to access the properties of an application's resources in order to locate the correct versions of those resources for the application. - [Hosting](./hosting/index.md) + [Hosting](./hosting/index.md)\ Describes the hosting API, which enables unmanaged hosts to integrate the CLR into their applications. - [Metadata](./metadata/index.md) - Describes the metadata API, which enables a client such as a compiler to generate or access a component's metadata without the types being loaded by the CLR. - - [Profiling](./profiling/index.md) + [Profiling](./profiling/index.md)\ Describes the profiling API, which enables a profiler to monitor a program's execution by the CLR. - [Strong Naming](./strong-naming/index.md) + [Strong Naming](./strong-naming/index.md)\ Describes the strong naming API, which enables a client to administer strong name signing for assemblies. - [WMI and Performance Counters](wmi/index.md) + [WMI and Performance Counters](wmi/index.md)\ Describes the APIs that wrap calls to Windows Management Instrumentation (WMI) libraries. - [Tlbexp Helper Functions](./tlbexp/index.md) + [Tlbexp Helper Functions](./tlbexp/index.md)\ Describes the two helper functions and interface used by the Type Library Exporter (Tlbexp.exe) during the assembly-to-type-library conversion process. diff --git a/docs/framework/unmanaged-api/metadata/ceesectionattr-enumeration.md b/docs/framework/unmanaged-api/metadata/ceesectionattr-enumeration.md deleted file mode 100644 index 24f3cc390f8d2..0000000000000 --- a/docs/framework/unmanaged-api/metadata/ceesectionattr-enumeration.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn more about: CeeSectionAttr Enumeration" -title: "CeeSectionAttr Enumeration" -ms.date: "03/30/2017" -api_name: - - "CeeSectionAttr" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CeeSectionAttr" -helpviewer_keywords: - - "CeeSectionAttr enumeration [.NET Framework metadata]" -ms.assetid: 0db51881-b869-4677-a715-1726a9216489 -topic_type: - - "apiref" ---- -# CeeSectionAttr Enumeration - -Provides values that specify attributes of a section for use by the [ICeeGen](iceegen-interface.md) interface. - -## Syntax - -```cpp -typedef enum { - sdNone = 0, - sdReadOnly = IMAGE_SCN_CNT_INITIALIZED_DATA | - IMAGE_SCN_MEM_READ, - sdReadWrite = sdReadOnly | IMAGE_SCN_MEM_WRITE, - sdExecute = IMAGE_SCN_MEM_READ | IMAGE_SCN_CNT_CODE | - IMAGE_SCN_MEM_EXECUTE -} CeeSectionAttr; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`sdNone`|Section has no attributes.| -|`sdReadOnly`|Section contains initialized data that can be only read, not updated.| -|`sdReadWrite`|Section contains initialized data that can be read or updated.| -|`sdExecute`|Section contains executable code that is allowed to be read and executed.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/ceesectionrelocextra-union.md b/docs/framework/unmanaged-api/metadata/ceesectionrelocextra-union.md deleted file mode 100644 index 011623f89a53e..0000000000000 --- a/docs/framework/unmanaged-api/metadata/ceesectionrelocextra-union.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: "Learn more about: CeeSectionRelocExtra Union" -title: "CeeSectionRelocExtra Union" -ms.date: "03/30/2017" -api_name: - - "CeeSectionRelocExtra Union" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CeeSectionRelocExtra" -helpviewer_keywords: - - "CeeSectionRelocExtra union [.NET Framework metadata]" -ms.assetid: d9568cf6-7f98-4cd6-ab36-0a2bd509afcc -topic_type: - - "apiref" ---- -# CeeSectionRelocExtra Union - -Represents an address offset that is used by the [ICeeGen](iceegen-interface.md) interface to relocate a section. - -## Syntax - -```cpp -typedef union { - USHORT highAdj; -} CeeSectionRelocExtra; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`highAdj`|The upper address adjustment for the section.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Unions](metadata-unions.md) diff --git a/docs/framework/unmanaged-api/metadata/coiniticor-enumeration.md b/docs/framework/unmanaged-api/metadata/coiniticor-enumeration.md deleted file mode 100644 index 6af2bf0a087e7..0000000000000 --- a/docs/framework/unmanaged-api/metadata/coiniticor-enumeration.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: "Learn more about: COINITICOR Enumeration" -title: "COINITICOR Enumeration" -ms.date: "03/30/2017" -api_name: - - "COINITICOR" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "COINITICOR" -helpviewer_keywords: - - "COINITICOR enumeration [.NET Framework metadata]" -ms.assetid: 67fefd89-28d6-4588-84ea-dc7a5870e014 -topic_type: - - "apiref" ---- -# COINITICOR Enumeration - -Specifies constants used by [CoInitializeCor](../hosting/coinitializecor-function.md) when it initializes the common language runtime. - -## Syntax - -```cpp -typedef enum tagCOINITCOR -{ - COINITCOR = 0x0 -} COINITICOR; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`COINITCOR`|Indicates the default initialization mode.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/coinitiee-enumeration.md b/docs/framework/unmanaged-api/metadata/coinitiee-enumeration.md deleted file mode 100644 index 4a1b8b2b92dff..0000000000000 --- a/docs/framework/unmanaged-api/metadata/coinitiee-enumeration.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: "Learn more about: COINITIEE Enumeration" -title: "COINITIEE Enumeration" -ms.date: "03/30/2017" -api_name: - - "COINITIEE" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "COINITIEE" -helpviewer_keywords: - - "COINITIEE enumeration [.NET Framework metadata]" -ms.assetid: 64264238-3b68-4bac-a887-36b552426a6c -topic_type: - - "apiref" ---- -# COINITIEE Enumeration - -Specifies constants used by [CoInitializeEE](../hosting/coinitializeee-function.md) when initializing the common language runtime. - -## Syntax - -```cpp -typedef enum tagCOINITEE { - COINITEE_DEFAULT = 0x0, - COINITEE_DLL = 0x1, - COINITEE_MAIN = 0x2 -} COINITIEE; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`COINITEE_DEFAULT`|Default initialization mode. This initializes the runtime and creates the default .| -|`COINITEE_DLL`|Initializes to run a managed DLL.| -|`COINITEE_MAIN`|Initializes to run a managed EXE. This initializes the runtime but does not create the default , which is created after entering the main routine of the EXE.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cor-field-offset-structure.md b/docs/framework/unmanaged-api/metadata/cor-field-offset-structure.md deleted file mode 100644 index 54bcf1724e5f9..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cor-field-offset-structure.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: "Learn more about: COR_FIELD_OFFSET Structure" -title: "COR_FIELD_OFFSET Structure" -ms.date: "03/30/2017" -api_name: - - "COR_FIELD_OFFSET" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "COR_FIELD_OFFSET" -helpviewer_keywords: - - "COR_FIELD_OFFSET structure [.NET Framework metadata]" -ms.assetid: cced5298-277f-4a5a-8ecf-a0050c1096ea -topic_type: - - "apiref" ---- -# COR_FIELD_OFFSET Structure - -Stores the offset, within a class, of the specified field. - -## Syntax - -```cpp -typedef struct COR_FIELD_OFFSET { - mdFieldDef ridOfField; - ULONG ulOffset; -} COR_FIELD_OFFSET; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`ridOfField`|An `mdFieldDef` metadata token that represents the field.| -|`ulOffset`|The field's offset within its class.| - -## Remarks - - [IMetaDataImport::GetClassLayout](imetadataimport-getclasslayout-method.md) and [IMetaDataEmit::SetClassLayout](imetadataemit-setclasslayout-method.md) methods take a parameter of type `COR_FIELD_OFFSET`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h, CorProf.idl - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Structures](metadata-structures.md) -- [IMetaDataEmit Interface](imetadataemit-interface.md) -- [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/corargtype-enumeration.md b/docs/framework/unmanaged-api/metadata/corargtype-enumeration.md deleted file mode 100644 index 5ed7e75e359f5..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corargtype-enumeration.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: "Learn more about: CorArgType Enumeration" -title: "CorArgType Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorArgType" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorArgType" -helpviewer_keywords: - - "CorArgType enumeration [.NET Framework metadata]" -ms.assetid: 3c1cb268-57a0-4664-91c7-f6908ff29e32 -topic_type: - - "apiref" ---- -# CorArgType Enumeration - -Contains values that describe the native type of a runtime handle. - -## Syntax - -```cpp -typedef enum CorArgType { - - IMAGE_CEE_CS_END = 0x0, - IMAGE_CEE_CS_VOID = 0x1, - IMAGE_CEE_CS_I4 = 0x2, - IMAGE_CEE_CS_I8 = 0x3, - IMAGE_CEE_CS_R4 = 0x4, - IMAGE_CEE_CS_R8 = 0x5, - IMAGE_CEE_CS_PTR = 0x6, - IMAGE_CEE_CS_OBJECT = 0x7, - IMAGE_CEE_CS_STRUCT4 = 0x8, - IMAGE_CEE_CS_STRUCT32 = 0x9, - IMAGE_CEE_CS_BYVALUE = 0xA - -} CorArgType; -``` - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corassemblyflags-enumeration.md b/docs/framework/unmanaged-api/metadata/corassemblyflags-enumeration.md deleted file mode 100644 index 0889c95a3c4ea..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corassemblyflags-enumeration.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -description: "Learn more about: CorAssemblyFlags Enumeration" -title: "CorAssemblyFlags Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorAssemblyFlags" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorAssemblyFlags" -helpviewer_keywords: - - "CorAssemblyFlags enumeration [.NET Framework metadata]" -ms.assetid: bb8db3b6-d81d-49fc-b74c-dbc908a9eab9 -topic_type: - - "apiref" ---- -# CorAssemblyFlags Enumeration - -Contains values that describe the metadata applied to an assembly compilation. - -## Syntax - -```cpp -typedef enum CorAssemblyFlags { - - afPublicKey = 0x0001, - afPA_None = 0x0000, - afPA_MSIL = 0x0010, - afPA_x86 = 0x0020, - afPA_IA64 = 0x0030, - afPA_AMD64 = 0x0040, - afPA_ARM = 0x0050, - afPA_NoPlatform = 0x0070, - afPA_Specified = 0x0080, - afPA_Mask = 0x0070, - afPA_FullMask = 0x00F0, - afPA_Shift = 0x0004, - - afEnableJITcompileTracking = 0x8000, - afDisableJITcompileOptimizer= 0x4000, - - afRetargetable = 0x0100, - afContentType_Default = 0x0000, - afContentType_WindowsRuntime = 0x0200, - afContentType_Mask = 0x0E00, - -} CorAssemblyFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`afPublicKey`|Indicates that the assembly reference holds the full, unhashed public key.| -|`afPA_None`|Indicates that the processor architecture is unspecified.| -|`afPA_MSIL`|Indicates that the processor architecture is neutral (PE32).| -|`afPA_x86`|Indicates that the processor architecture is x86 (PE32).| -|`afPA_IA64`|Indicates that the processor architecture is Itanium (PE32+).| -|`afPA_AMD64`|Indicates that the processor architecture is AMD X64 (PE32+).| -|`afPA_ARM`|Indicates that the processor architecture is ARM (PE32).| -|`afPA_NoPlatform`|Indicates that the assembly is a reference assembly; that is, it applies to any architecture but cannot run on any architecture. Thus, the flag is the same as `afPA_Mask`.| -|`afPA_Specified`|Indicates that the processor architecture flags should be propagated to the `AssemblyRef` record.| -|`afPA_Mask`|A mask that describes the processor architecture.| -|`afPA_FullMask`|Specifies that the processor architecture description is included.| -|`afPA_Shift`|Indicates a shift count in the processor architecture flags to and from the index.| -|`afEnableJITcompileTracking`|Indicates the corresponding value from the of the .| -|`afDisableJITcompileOptimizer`|Indicates the corresponding value from the of the .| -|`afRetargetable`|Indicates that the assembly can be retargeted at run time to an assembly from a different publisher.| -|`afContentType_Mask`|A mask that describes the content type.| -|`afContentType_Default`|Indicates the default content type.| -|`afContentType_WindowsRuntime`|Indicates the Windows Runtime content type.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corattributetargets-enumeration.md b/docs/framework/unmanaged-api/metadata/corattributetargets-enumeration.md deleted file mode 100644 index ef9e9ea02013e..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corattributetargets-enumeration.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -description: "Learn more about: CorAttributeTargets Enumeration" -title: "CorAttributeTargets Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorAttributeTargets" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorAttributeTargets" -helpviewer_keywords: - - "CorAttributeTargets enumeration [.NET Framework metadata]" -ms.assetid: 694c0fa0-7011-41a9-9dfd-f0e16ea574b5 -topic_type: - - "apiref" ---- -# CorAttributeTargets Enumeration - -Specifies the application elements on which it is valid to apply an attribute. - -## Syntax - -```cpp -typedef enum CorAttributeTargets -{ - catAssembly = 0x0001, - catModule = 0x0002, - catClass = 0x0004, - catStruct = 0x0008, - catEnum = 0x0010, - catConstructor = 0x0020, - catMethod = 0x0040, - catProperty = 0x0080, - catField = 0x0100, - catEvent = 0x0200, - catInterface = 0x0400, - catParameter = 0x0800, - catDelegate = 0x1000, - catGenericParameter = 0x4000, - - catAll = - catAssembly | catModule | catClass | catStruct | - catEnum | catConstructor | catMethod | catProperty | - catField | catEvent | catInterface | catParameter | - catDelegate | catGenericParameter, - - catClassMembers = - catClass | catStruct | catEnum | catConstructor | - catMethod | catProperty | catField | catEvent | - catDelegate | catInterface - -} CorAttributeTargets; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`catAssembly`|Attribute can be applied to an assembly.| -|`catModule`|Attribute can be applied to a portable executable (.dll or .exe) module.| -|`catClass`|Attribute can be applied to a class.| -|`catStruct`|Attribute can be applied to a structure; that is, a value type.| -|`catEnum`|Attribute can be applied to an enumeration.| -|`catConstructor`|Attribute can be applied to a constructor.| -|`catMethod`|Attribute can be applied to a method.| -|`catProperty`|Attribute can be applied to a property.| -|`catField`|Attribute can be applied to a field.| -|`catEvent`|Attribute can be applied to an event.| -|`catInterface`|Attribute can be applied to an interface.| -|`catParameter`|Attribute can be applied to a parameter.| -|`catDelegate`|Attribute can be applied to a delegate.| -|`catGenericParameter`|Attribute can be applied to a generic parameter.| -|`catAll`|Attribute can be applied to any application element.| -|`catClassMembers`|Attribute can be applied to a member of a class.| - -## Remarks - - The `CorAttributeTargets` enumeration values can be combined with a bitwise OR operation to get the preferred combination. - - The `CorAttributeTargets` parallels the managed enumeration. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corcallingconvention-enumeration.md b/docs/framework/unmanaged-api/metadata/corcallingconvention-enumeration.md deleted file mode 100644 index 3265933398411..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corcallingconvention-enumeration.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -description: "Learn more about: CorCallingConvention Enumeration" -title: "CorCallingConvention Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorCallingConvention" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorCallingConvention" -helpviewer_keywords: - - "CorCallingConvention enumeration [.NET Framework metadata]" -ms.assetid: 69156fbf-7219-43bf-b4b8-b13f1a2fcb86 -topic_type: - - "apiref" ---- -# CorCallingConvention Enumeration - -Contains values that describe the types of calling conventions that are made in managed code. - -## Syntax - -```cpp -typedef enum CorCallingConvention -{ - IMAGE_CEE_CS_CALLCONV_DEFAULT = 0x0, - - IMAGE_CEE_CS_CALLCONV_VARARG = 0x5, - IMAGE_CEE_CS_CALLCONV_FIELD = 0x6, - IMAGE_CEE_CS_CALLCONV_LOCAL_SIG = 0x7, - IMAGE_CEE_CS_CALLCONV_PROPERTY = 0x8, - IMAGE_CEE_CS_CALLCONV_UNMGD = 0x9, - IMAGE_CEE_CS_CALLCONV_GENERICINST = 0xa, - IMAGE_CEE_CS_CALLCONV_NATIVEVARARG = 0xb, - IMAGE_CEE_CS_CALLCONV_MAX = 0xc, - - IMAGE_CEE_CS_CALLCONV_MASK = 0x0f, - IMAGE_CEE_CS_CALLCONV_HASTHIS = 0x20, - IMAGE_CEE_CS_CALLCONV_EXPLICITTHIS = 0x40, - IMAGE_CEE_CS_CALLCONV_GENERIC = 0x10 - -} CorCallingConvention; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`IMAGE_CEE_CS_CALLCONV_DEFAULT`|Indicates a default calling convention.| -|`IMAGE_CEE_CS_CALLCONV_VARARG`|Indicates that the method takes a variable number of parameters.| -|`IMAGE_CEE_CS_CALLCONV_FIELD`|Indicates that the call is to a field.| -|`IMAGE_CEE_CS_CALLCONV_LOCAL_SIG`|Indicates that the call is to a local method.| -|`IMAGE_CEE_CS_CALLCONV_PROPERTY`|Indicates that the call is to a property.| -|`IMAGE_CEE_CS_CALLCONV_UNMGD`|Indicates that the call is unmanaged.| -|`IMAGE_CEE_CS_CALLCONV_GENERICINST`|Indicates a generic method instantiation.| -|`IMAGE_CEE_CS_CALLCONV_NATIVEVARARG`|Indicates a 64-bit PInvoke call to a method that takes a variable number of parameters.| -|`IMAGE_CEE_CS_CALLCONV_MAX`|Describes an invalid 4-bit value.| -|`IMAGE_CEE_CS_CALLCONV_MASK`|Indicates that the calling convention is described by the bottom four bits.| -|`IMAGE_CEE_CS_CALLCONV_HASTHIS`|Indicates that the top bit describes a `this` parameter.| -|`IMAGE_CEE_CS_CALLCONV_EXPLICITTHIS`|Indicates that a `this` parameter is explicitly described in the signature.| -|`IMAGE_CEE_CS_CALLCONV_GENERIC`|Indicates a generic method signature with an explicit number of type arguments. This precedes an ordinary parameter count.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md b/docs/framework/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md deleted file mode 100644 index b6c7c3f1de26f..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -description: "Learn more about: CorCheckDuplicatesFor Enumeration" -title: "CorCheckDuplicatesFor Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorCheckDuplicatesFor" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorCheckDuplicatesFor" -helpviewer_keywords: - - "CorCheckDuplicatesFor enumeration [.NET Framework metadata]" -ms.assetid: d8ec8d3c-70f7-4cc6-9957-68068fd8f49c -topic_type: - - "apiref" ---- -# CorCheckDuplicatesFor Enumeration - -Specifies the metadata tokens that will be checked for duplicates. - -## Syntax - -```cpp -typedef enum CorCheckDuplicatesFor { - - MDDupAll = 0xffffffff, - MDDupENC = MDDupAll, - MDNoDupChecks = 0x00000000, - MDDupTypeDef = 0x00000001, - MDDupInterfaceImpl = 0x00000002, - MDDupMethodDef = 0x00000004, - MDDupTypeRef = 0x00000008, - MDDupMemberRef = 0x00000010, - MDDupCustomAttribute = 0x00000020, - MDDupParamDef = 0x00000040, - MDDupPermission = 0x00000080, - MDDupProperty = 0x00000100, - MDDupEvent = 0x00000200, - MDDupFieldDef = 0x00000400, - MDDupSignature = 0x00000800, - MDDupModuleRef = 0x00001000, - MDDupTypeSpec = 0x00002000, - MDDupImplMap = 0x00004000, - MDDupAssemblyRef = 0x00008000, - MDDupFile = 0x00010000, - MDDupExportedType = 0x00020000, - MDDupManifestResource = 0x00040000, - MDDupGenericParam = 0x00080000, - MDDupMethodSpec = 0x00100000, - MDDupGenericParamConstraint = 0x00200000, - - MDDupAssembly = 0x10000000, - - MDDupDefault = - MDNoDupChecks | MDDupTypeRef | MDDupMemberRef | - MDDupSignature | MDDupTypeSpec | MDDupMethodSpec - -} CorCheckDuplicatesFor; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MDDupAll`|Check all metadata tokens for duplicates.| -|`MDDupENC`|Not used.| -|`MDNoDupChecks`|Do not check metadata tokens for duplicates.| -|`MDDupTypeDef`|Check for duplicates of `mdTypeDef` tokens.| -|`MDDupInterfaceImpl`|Check for duplicates of `mdInterfaceImpl` tokens.| -|`MDDupMethodDef`|Check for duplicates of `mdMethodDef` tokens.| -|`MDDupTypeRef`|Check for duplicates of `mdTypeRef` tokens.| -|`MDDupMemberRef`|Check for duplicates of `mdMemberRef` tokens.| -|`MDDupCustomAttribute`|Check for duplicates of `mdCustomAttribute` tokens.| -|`MDDupParamDef`|Check for duplicates of `mdParamDef` tokens.| -|`MDDupPermission`|Check for duplicates of `mdPermission` tokens.| -|`MDDupProperty`|Check for duplicates of `mdProperty` tokens.| -|`MDDupEvent`|Check for duplicates of `mdEvent` tokens.| -|`MDDupFieldDef`|Check for duplicates of `mdFieldDef` tokens.| -|`MDDupSignature`|Check for duplicates of `mdSignature` tokens.| -|`MDDupModuleRef`|Check for duplicates of `mdModuleRef` tokens.| -|`MDDupTypeSpec`|Check for duplicates of `mdTypeSpec` tokens.| -|`MDDupImplMap`|Check for duplicates of `mdImplMap` tokens.| -|`MDDupAssemblyRef`|Check for duplicates of `mdAssemblyRef` tokens.| -|`MDDupFile`|Check for duplicates of `mdFile` tokens.| -|`MDDupExportedType`|Check for duplicates of `mdExportedType` tokens.| -|`MDDupManifestResource`|Check for duplicates of `mdManifestResource` tokens.| -|`MDDupGenericParam`|Check for duplicates of `mdGenericParam` tokens.| -|`MDDupMethodSpec`|Check for duplicates of `mdMethodSpec` tokens.| -|`MDDupGenericParamConstraint`|Check for duplicates of `mdGenericParamConstraint` tokens.| -|`MDDupAssembly`|Check for duplicates of `mdAssembly` tokens.| -|`MDDupDefault`|Check for duplicates of `mdMemberRef`, `mdTypeRef`, `mdSignature`, `mdTypeSpec`, and `mdMethodSpec` tokens.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cordeclsecurity-enumeration.md b/docs/framework/unmanaged-api/metadata/cordeclsecurity-enumeration.md deleted file mode 100644 index 0f3b2cbdeea43..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cordeclsecurity-enumeration.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -description: "Learn more about: CorDeclSecurity Enumeration" -title: "CorDeclSecurity Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorDeclSecurity" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorDeclSecurity" -helpviewer_keywords: - - "CorDeclSecurity enumeration [.NET Framework metadata]" -ms.assetid: 864f1267-d267-4696-8df7-1f83f8444d6f -topic_type: - - "apiref" ---- -# CorDeclSecurity Enumeration - -Specifies the security actions that can be performed using declarative security. - -## Syntax - -```cpp -typedef enum CorDeclSecurity { - - dclActionMask = 0x001f, - dclActionNil = 0x0000, - dclRequest = 0x0001, - dclDemand = 0x0002, - dclAssert = 0x0003, - dclDeny = 0x0004, - dclPermitOnly = 0x0005, - dclLinktimeCheck = 0x0006, - dclInheritanceCheck = 0x0007, - dclRequestMinimum = 0x0008, - dclRequestOptional = 0x0009, - dclRequestRefuse = 0x000a, - dclPrejitGrant = 0x000b, - dclPrejitDenied = 0x000c, - dclNonCasDemand = 0x000d, - dclNonCasLinkDemand = 0x000e, - dclNonCasInheritance = 0x000f, - dclLinkDemandChoice = 0x0010, - dclInheritanceDemandChoice = 0x0011, - dclDemandChoice = 0x0012, - dclMaximumValue = 0x0012 - -} CorDeclSecurity; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`dclActionMask`|Reserved.| -|`dclActionNil`|Reserved.| -|`dclRequest`|Reserved.| -|`dclDemand`|All callers higher in the call stack are required to have been granted the permission specified by the current permission object.| -|`dclAssert`|The calling code can access the resource identified by the current permission object, even if callers higher in the stack have not been granted permission to access the resource| -|`dclDeny`|The ability to access the resource specified by the current permission object is denied to callers, even if they have been granted permission to access it.| -|`dclPermitOnly`|Only the resources specified by this permission object can be accessed, even if the code has been granted permission to access other resources.| -|`dclLinktimeCheck`|The immediate caller is required to have been granted the specified permission for a given period of time.| -|`dclInheritanceCheck`|The derived class inheriting another class or overriding a method is required to have been granted the specified permission.| -|`dclRequestMinimum`|The caller can request for the minimum permissions required for code to run. This action can only be used within the scope of the assembly.| -|`dclRequestOptional`|The caller can request for additional permissions that are optional (not required to run). This request implicitly refuses all other permissions not specifically requested. This action can only be used within the scope of the assembly.| -|`dclRequestRefuse`|The caller's request for permissions that might be misused will not be granted. This action can only be used within the scope of the assembly.| -|`dclPrejitGrant`|Reserved.| -|`dclPrejitDenied`|Reserved.| -|`dclNonCasDemand`|Reserved.| -|`dclNonCasLinkDemand`|The immediate caller is required to have been granted the specified permission.| -|`dclNonCasInheritance`|Reserved.| -|`dclLinkDemandChoice`|Reserved.| -|`dclInheritanceDemandChoice`|Reserved.| -|`dclDemandChoice`|Reserved.| -|`dclMaximumValue`|Reserved.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md b/docs/framework/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md deleted file mode 100644 index b9543ee8e0585..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: "Learn more about: CorErrorIfEmitOutOfOrder Enumeration" -title: "CorErrorIfEmitOutOfOrder Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorErrorIfEmitOutOfOrder" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorErrorIfEmitOutOfOrder" -helpviewer_keywords: - - "CorErrorIfEmitOutOfOrder enumeration [.NET Framework metadata]" -ms.assetid: 6d758aad-29a7-44fe-9481-bbff5b799a32 -topic_type: - - "apiref" ---- -# CorErrorIfEmitOutOfOrder Enumeration - -Contains flag values that indicate the conditions under which an error message should be generated when metadata is emitted out of order. - -## Syntax - -```cpp -typedef enum CorErrorIfEmitOutOfOrder { - - MDErrorOutOfOrderDefault = 0x00000000, - MDErrorOutOfOrderNone = 0x00000000, - MDErrorOutOfOrderAll = 0xffffffff, - MDMethodOutOfOrder = 0x00000001, - MDFieldOutOfOrder = 0x00000002, - MDParamOutOfOrder = 0x00000004, - MDPropertyOutOfOrder = 0x00000008, - MDEventOutOfOrder = 0x00000010 - -} CorErrorIfEmitOutOfOrder; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MDErrorOutOfOrderDefault`|Indicates the default behavior, which does not generate error messages.| -|`MDErrorOutOfOrderNone`|Indicates that the compiler should not generate error messages.| -|`MDErrorOutOfOrderAll`|Indicates that the compiler should generate an error message when a field, property, event, method, or parameter is emitted out of order.| -|`MDMethodOutOfOrder`|Indicates that the compiler should generate an error message when a method is emitted out of order.| -|`MDFieldOutOfOrder`|Indicates that the compiler should generate an error message when a field is emitted out of order.| -|`MDParamOutOfOrder`|Indicates that the compiler should generate an error message when a parameter is emitted out of order.| -|`MDPropertyOutOfOrder`|Indicates that the compiler should generate an error message when a property is emitted out of order.| -|`MDEventOutOfOrder`|Indicates that the compiler should generate an error message when an event is emitted out of order.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/coreventattr-enumeration.md b/docs/framework/unmanaged-api/metadata/coreventattr-enumeration.md deleted file mode 100644 index 739c9b7fa33f9..0000000000000 --- a/docs/framework/unmanaged-api/metadata/coreventattr-enumeration.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: CorEventAttr Enumeration" -title: "CorEventAttr Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorEventAttr" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorEventAttr" -helpviewer_keywords: - - "CorEventAttr enumeration [.NET Framework metadata]" -ms.assetid: dc2b3281-3820-487e-930d-350b66dc6417 -topic_type: - - "apiref" ---- -# CorEventAttr Enumeration - -Contains values that describe the metadata of an event. - -## Syntax - -```cpp -typedef enum CorEventAttr { - - evSpecialName = 0x0200, - - evReservedMask = 0x0400, - evRTSpecialName = 0x0400, - -} CorEventAttr; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`evSpecialName`|Specifies that the event is special, and that its name describes how.| -|`evReservedMask`|Reserved for internal use by the common language runtime.| -|`evRTSpecialName`|Specifies that the common language runtime should check the encoding of the event name.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corfieldattr-enumeration.md b/docs/framework/unmanaged-api/metadata/corfieldattr-enumeration.md deleted file mode 100644 index b8ecd21339fa1..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corfieldattr-enumeration.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -description: "Learn more about: CorFieldAttr Enumeration" -title: "CorFieldAttr Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorFieldAttr" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorFieldAttr" -helpviewer_keywords: - - "CorFieldAttr enumeration [.NET Framework metadata]" -ms.assetid: 6ae2c4be-212c-4e74-9288-40a11dc26522 -topic_type: - - "apiref" ---- -# CorFieldAttr Enumeration - -Contains values that describe metadata about a field. - -## Syntax - -```cpp -typedef enum CorFieldAttr { - - fdFieldAccessMask = 0x0007, - fdPrivateScope = 0x0000, - fdPrivate = 0x0001, - fdFamANDAssem = 0x0002, - fdAssembly = 0x0003, - fdFamily = 0x0004, - fdFamORAssem = 0x0005, - fdPublic = 0x0006, - - fdStatic = 0x0010, - fdInitOnly = 0x0020, - fdLiteral = 0x0040, - fdNotSerialized = 0x0080, - - fdSpecialName = 0x0200, - - fdPinvokeImpl = 0x2000, - - fdReservedMask = 0x9500, - fdRTSpecialName = 0x0400, - fdHasFieldMarshal = 0x1000, - fdHasDefault = 0x8000, - fdHasFieldRVA = 0x0100 - -} CorFieldAttr; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`fdFieldAccessMask`|Specifies accessibility information.| -|`fdPrivateScope`|Specifies that the field cannot be referenced.| -|`fdPrivate`|Specifies that the field is accessible only by its parent type.| -|`fdFamANDAssem`|Specifies that the field is accessible by derived classes in its assembly.| -|`fdAssembly`|Specifies that the field is accessible by all types in its assembly.| -|`fdFamily`|Specifies that the field is accessible only by its type and derived classes.| -|`fdFamORAssem`|Specifies that the field is accessible by derived classes and by all types in its assembly.| -|`fdPublic`|Specifies that the field is accessible by all types with visibility of this scope.| -|`fdStatic`|Specifies that the field is a member of its type rather than an instance member.| -|`fdInitOnly`|Specifies that the field cannot be changed after it is initialized.| -|`fdLiteral`|Specifies that the field value is a compile-time constant.| -|`fdNotSerialized`|Specifies that the field is not serialized when its type is remoted.| -|`fdSpecialName`|Specifies that the field is special, and that its name describes how.| -|`fdPinvokeImpl`|Specifies that the field implementation is forwarded through PInvoke.| -|`fdReservedMask`|Reserved for internal use by the common language runtime.| -|`fdRTSpecialName`|Specifies that the common language runtime metadata internal APIs should check the encoding of the name.| -|`fdHasFieldMarshal`|Specifies that the field contains marshalling information.| -|`fdHasDefault`|Specifies that the field has a default value.| -|`fdHasFieldRVA`|Specifies that the field has a relative virtual address.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corfileflags-enumeration.md b/docs/framework/unmanaged-api/metadata/corfileflags-enumeration.md deleted file mode 100644 index a6832b85400af..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corfileflags-enumeration.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: "Learn more about: CorFileFlags Enumeration" -title: "CorFileFlags Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorFileFlags" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorFileFlags" -helpviewer_keywords: - - "CorFileFlags enumeration [.NET Framework metadata]" -ms.assetid: d16703fd-518f-412e-92cb-74433d11032e -topic_type: - - "apiref" ---- -# CorFileFlags Enumeration - -Contains values that describe the type of file defined in a call to [IMetaDataAssemblyEmit::DefineFile](imetadataassemblyemit-definefile-method.md). - -## Syntax - -```cpp -typedef enum CorFileFlags { - - ffContainsMetaData = 0x0000, - ffContainsNoMetaData = 0x0001 - -} CorFileFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`ffContainsMetaData`|Indicates that the file is not a resource file.| -|`ffContainsNoMetaData`|Indicates that the file, possibly a resource file, does not contain metadata.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corgenericparamattr-enumeration.md b/docs/framework/unmanaged-api/metadata/corgenericparamattr-enumeration.md deleted file mode 100644 index ce5d234517a10..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corgenericparamattr-enumeration.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -description: "Learn more about: CorGenericParamAttr Enumeration" -title: "CorGenericParamAttr Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorGenericParamAttr" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorGenericParamAttr" -helpviewer_keywords: - - "CorGenericParamAttr enumeration [.NET Framework metadata]" -ms.assetid: 36c76266-71d8-48dc-bd89-54943fa659c1 -topic_type: - - "apiref" ---- -# CorGenericParamAttr Enumeration - -Contains values that describe the parameters for generic types, as used in calls to [IMetaDataEmit2::DefineGenericParam](imetadataemit2-definegenericparam-method.md). - -## Syntax - -```cpp -typedef enum CorGenericParamAttr { - - gpVarianceMask = 0x0003, - gpNonVariant = 0x0000, - gpCovariant = 0x0001, - gpContravariant = 0x0002, - - gpSpecialConstraintMask = 0x001C, - gpNoSpecialConstraint = 0x0000, - gpReferenceTypeConstraint = 0x0004, - gpNotNullableValueTypeConstraint = 0x0008, - gpDefaultConstructorConstraint = 0x0010 - -} CorGenericParamAttr; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`gpVarianceMask`|Parameter variance applies only to generic parameters for interfaces and delegates.| -|`gpNonVariant`|Indicates the absence of variance.| -|`gpCovariant`|Indicates covariance.| -|`gpContravariant`|Indicates contravariance.| -|`gpSpecialConstraintMask`|Special constraints can apply to any parameter.| -|`gpNoSpecialConstraint`|Indicates that no constraint applies to the parameter.| -|`gpReferenceTypeConstraint`|Indicates that the parameter must be a reference type.| -|`gpNotNullableValueTypeConstraint`|Indicates that the parameter must be a value type that cannot be a null value.| -|`gpDefaultConstructorConstraint`|Indicates that the parameter must have a default public constructor that takes no parameters.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corimportoptions-enumeration.md b/docs/framework/unmanaged-api/metadata/corimportoptions-enumeration.md deleted file mode 100644 index 8d4f41ce4b3f8..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corimportoptions-enumeration.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: "Learn more about: CorImportOptions Enumeration" -title: "CorImportOptions Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorImportOptions" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorImportOptions" -helpviewer_keywords: - - "CorImportOptions enumeration [.NET Framework metadata]" -ms.assetid: 4e5d03cb-97c9-4ff4-8dbd-17d94ee374d3 -topic_type: - - "apiref" ---- -# CorImportOptions Enumeration - -Contains flag values that control the behavior during importation of an assembly outside the current scope. - -## Syntax - -```cpp -typedef enum CorImportOptions { - - MDImportOptionDefault = 0x00000000, - MDImportOptionAll = 0xFFFFFFFF, - MDImportOptionAllTypeDefs = 0x00000001, - MDImportOptionAllMethodDefs = 0x00000002, - MDImportOptionAllFieldDefs = 0x00000004, - MDImportOptionAllProperties = 0x00000008, - MDImportOptionAllEvents = 0x00000010, - MDImportOptionAllCustomAttributes = 0x00000020, - MDImportOptionAllExportedTypes = 0x00000040 - -} CorImportOptions; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MDImportOptionDefault`|Indicates the default behavior, which is to skip deleted records.| -|`MDImportOptionAll`|Indicates that all metadata should be enumerated.| -|`MDImportOptionAllTypeDefs`|Indicates that all TypeDefs, including deleted ones, should be enumerated.| -|`MDImportOptionAllMethodDefs`|Indicates that all MethodDefs, including deleted ones, should be enumerated.| -|`MDImportOptionAllFieldDefs`|Indicates that all FieldDefs, including deleted ones, should be enumerated.| -|`MDImportOptionAllProperties`|Indicates that all PropertyDefs, including deleted ones, should be enumerated.| -|`MDImportOptionAllEvents`|Indicates that all EventDefs, including deleted ones, should be enumerated.| -|`MDImportOptionAllCustomAttributes`|Indicates that all custom attributes, including deleted ones, should be enumerated.| -|`MDImportOptionAllExportedTypes`|Indicates that all exported types, including deleted ones, should be enumerated.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corlinkeroptions-enumeration.md b/docs/framework/unmanaged-api/metadata/corlinkeroptions-enumeration.md deleted file mode 100644 index 933a9857b2c9e..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corlinkeroptions-enumeration.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: "Learn more about: CorLinkerOptions Enumeration" -title: "CorLinkerOptions Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorLinkerOptions" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorLinkerOptions" -helpviewer_keywords: - - "CorLinkerOptions enumeration [.NET Framework metadata]" -ms.assetid: a656aad6-cc7e-4994-8251-004a6a45e18f -topic_type: - - "apiref" ---- -# CorLinkerOptions Enumeration - -Specifies flags to select options for the metadata linker. - -## Syntax - -```cpp -typedef enum CorLinkerOptions { - MDAssembly = 0x00000000, - MDNetModule = 0x00000001, -} CorLinkerOptions; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MDAssembly`|The private types and global functions are not preserved.| -|`MDNetModule`|The private types and global functions are preserved.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md b/docs/framework/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md deleted file mode 100644 index 35a00d53ee0a2..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: "Learn more about: CorLocalRefPreservation Enumeration" -title: "CorLocalRefPreservation Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorLocalRefPreservation" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorLocalRefPreservation" -helpviewer_keywords: - - "CorLocalRefPreservation enumeration [.NET Framework metadata]" -ms.assetid: 44757163-1228-4213-a4c4-d4de503cc75d -topic_type: - - "apiref" ---- -# CorLocalRefPreservation Enumeration - -Contains flag values for the treatment of local references. - -## Syntax - -```cpp -typedef enum CorLocalRefPreservation -{ - MDPreserveLocalRefsNone = 0x00000000, - MDPreserveLocalTypeRef = 0x00000001, - MDPreserveLocalMemberRef = 0x00000002 -} CorLocalRefPreservation; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MDPreserveLocalRefsNone`|Preserve no local references.| -|`MDPreserveLocalTypeRef`|Preserve local type references.| -|`MDPreserveLocalMemberRef`|Preserve local member references.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md b/docs/framework/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md deleted file mode 100644 index a914b0a128616..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: "Learn more about: CorManifestResourceFlags Enumeration" -title: "CorManifestResourceFlags Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorManifestResourceFlags" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorManifestResourceFlags" -helpviewer_keywords: - - "CorManifestResourceFlags enumeration [.NET Framework metadata]" -ms.assetid: 1b0306b7-622b-4b57-8edc-3c713bb147ae -topic_type: - - "apiref" ---- -# CorManifestResourceFlags Enumeration - -Indicates the visibility of resources encoded in an assembly manifest. - -## Syntax - -```cpp -typedef enum CorManifestResourceFlags { - - mrVisibilityMask = 0x0007, - mrPublic = 0x0001, - mrPrivate = 0x0002 - -} CorManifestResourceFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`mrVisibilityMask`|Reserved.| -|`mrPublic`|The resources are public.| -|`mrPrivate`|The resources are private.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cormethodattr-enumeration.md b/docs/framework/unmanaged-api/metadata/cormethodattr-enumeration.md deleted file mode 100644 index 0979c18ec16bb..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cormethodattr-enumeration.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -description: "Learn more about: CorMethodAttr Enumeration" -title: "CorMethodAttr Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorMethodAttr" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorMethodAttr" -helpviewer_keywords: - - "CorMethodAttr enumeration [.NET Framework metadata]" -ms.assetid: 4e0c3521-e54d-43c1-9857-cc76b49b8ffc -topic_type: - - "apiref" ---- -# CorMethodAttr Enumeration - -Contains values that describe the features of a method. - -## Syntax - -```cpp -typedef enum CorMethodAttr { - - mdMemberAccessMask = 0x0007, - mdPrivateScope = 0x0000, - mdPrivate = 0x0001, - mdFamANDAssem = 0x0002, - mdAssem = 0x0003, - mdFamily = 0x0004, - mdFamORAssem = 0x0005, - mdPublic = 0x0006, - - mdStatic = 0x0010, - mdFinal = 0x0020, - mdVirtual = 0x0040, - mdHideBySig = 0x0080, - - mdVtableLayoutMask = 0x0100, - mdReuseSlot = 0x0000, - mdNewSlot = 0x0100, - - mdCheckAccessOnOverride = 0x0200, - mdAbstract = 0x0400, - mdSpecialName = 0x0800, - - mdPinvokeImpl = 0x2000, - mdUnmanagedExport = 0x0008, - - mdReservedMask = 0xd000, - mdRTSpecialName = 0x1000, - mdHasSecurity = 0x4000, - mdRequireSecObject = 0x8000, - -} CorMethodAttr; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`mdMemberAccessMask`|Specifies member access.| -|`mdPrivateScope`|Specifies that the member cannot be referenced.| -|`mdPrivate`|Specifies that the member is accessible only by the parent type.| -|`mdFamANDAssem`|Specifies that the member is accessible by subtypes only in this assembly.| -|`mdAssem`|Specifies that the member is accessibly by anyone in the assembly.| -|`mdFamily`|Specifies that the member is accessible only by type and subtypes.| -|`mdFamORAssem`|Specifies that the member is accessible by derived classes and by other types in its assembly.| -|`mdPublic`|Specifies that the member is accessible by all types with access to the scope.| -|`mdStatic`|Specifies that the member is defined as part of the type rather than as a member of an instance.| -|`mdFinal`|Specifies that the method cannot be overridden.| -|`mdVirtual`|Specifies that the method can be overridden.| -|`mdHideBySig`|Specifies that the method hides by name and signature, rather than just by name.| -|`mdVtableLayoutMask`|Specifies virtual table layout.| -|`mdReuseSlot`|Specifies that the slot used for this method in the virtual table be reused. This is the default.| -|`mdNewSlot`|Specifies that the method always gets a new slot in the virtual table.| -|`mdCheckAccessOnOverride`|Specifies that the method can be overridden by the same types to which it is visible.| -|`mdAbstract`|Specifies that the method is not implemented.| -|`mdSpecialName`|Specifies that the method is special, and that its name describes how.| -|`mdPinvokeImpl`|Specifies that the method implementation is forwarded using PInvoke.| -|`mdUnmanagedExport`|Specifies that the method is a managed method exported to unmanaged code.| -|`mdReservedMask`|Reserved for internal use by the common language runtime.| -|`mdRTSpecialName`|Specifies that the common language runtime should check the encoding of the method name.| -|`mdHasSecurity`|Specifies that the method has security associated with it.| -|`mdRequireSecObject`|Specifies that the method calls another method containing security code.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md b/docs/framework/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md deleted file mode 100644 index 36034be47d383..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: "Learn more about: CorMethodSemanticsAttr Enumeration" -title: "CorMethodSemanticsAttr Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorMethodSemanticsAttr" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorMethodSemanticsAttr" -helpviewer_keywords: - - "CorMethodSemanticsAttr enumeration [.NET Framework metadata]" -ms.assetid: ca2af325-eb9d-4a91-90e4-267e45b98611 -topic_type: - - "apiref" ---- -# CorMethodSemanticsAttr Enumeration - -Contains values that describe the relationship between a method and an associated property or event. - -## Syntax - -```cpp -typedef enum CorMethodSemanticsAttr { - - msSetter = 0x0001, - msGetter = 0x0002, - msOther = 0x0004, - msAddOn = 0x0008, - msRemoveOn = 0x0010, - msFire = 0x0020, - -} CorMethodSemanticsAttr; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`msSetter`|Specifies that the method is a `set` accessor for a property.| -|`msGetter`|Specifies that the method is a `get` accessor for a property.| -|`msOther`|Specifies that the method has a relationship to a property or an event other than those defined here.| -|`msAddOn`|Specifies that the method adds handler methods for an event.| -|`msRemoveOn`|Specifies that the method removes handler methods for an event.| -|`msFire`|Specifies that the method raises an event.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cornativelinkflags-enumeration.md b/docs/framework/unmanaged-api/metadata/cornativelinkflags-enumeration.md deleted file mode 100644 index 34dcdbb172643..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cornativelinkflags-enumeration.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: "Learn more about: CorNativeLinkFlags Enumeration" -title: "CorNativeLinkFlags Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorNativeLinkFlags" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorNativeLinkFlags" -helpviewer_keywords: - - "CorNativeLinkFlags enumeration [.NET Framework metadata]" -ms.assetid: 8027df7c-cfad-4724-bda0-7538d9519070 -topic_type: - - "apiref" ---- -# CorNativeLinkFlags Enumeration - -Provides flag values used by the linker when linking native code. - -## Syntax - -```cpp -typedef enum -{ - nlfNone = 0x00, - nlfLastError = 0x01, - nlfNoMangle = 0x02, - nlfMaxValue = 0x03 -} CorNativeLinkFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`nlfNone`|Indicates no flags.| -|`nlfLastError`|Indicates a `setLastError` keyword.| -|`nlfNoMangle`|Indicates a `nomangle` keyword.| -|`nlfMaxValue`|Not used.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cornativelinktype-enumeration.md b/docs/framework/unmanaged-api/metadata/cornativelinktype-enumeration.md deleted file mode 100644 index 05f635fed26e9..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cornativelinktype-enumeration.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -description: "Learn more about: CorNativeLinkType Enumeration" -title: "CorNativeLinkType Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorNativeLinkType" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorNativeLinkType" -helpviewer_keywords: - - "CorNativeLinkType enumeration [.NET Framework metadata]" -ms.assetid: 4f86ff37-2dab-4e64-819a-76b3bfe828ff -topic_type: - - "apiref" ---- -# CorNativeLinkType Enumeration - -Provides values that indicate the type linked in native code. - -## Syntax - -```cpp -typedef enum -{ - nltNone = 1, - nltAnsi = 2, - nltUnicode = 3, - nltAuto = 4, - nltOle = 5, - nltMaxValue = 7 -} CorNativeLinkType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`nltNone`|Indicates that none of the keywords are specified.| -|`nltAnsi`|Indicates that an ANSI keyword is specified.| -|`nltUnicode`|Indicates that a Unicode keyword is specified| -|`nltAuto`|Indicates that an auto keyword is specified.| -|`nltOle`|Indicates that an OLE keyword is specified.| -|`nltMaxValue`|Not used.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cornativetype-enumeration.md b/docs/framework/unmanaged-api/metadata/cornativetype-enumeration.md deleted file mode 100644 index 0d7bdbe719a47..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cornativetype-enumeration.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -description: "Learn more about: CorNativeType Enumeration" -title: "CorNativeType Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorNativeType" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorNativeType" -helpviewer_keywords: - - "CorNativeType enumeration [.NET Framework metadata]" -ms.assetid: e47a72f1-9609-48ed-bb34-97170d7f6890 -topic_type: - - "apiref" ---- -# CorNativeType Enumeration - -Contains values that describe native unmanaged types. - -## Syntax - -```cpp -typedef enum CorNativeType { - - NATIVE_TYPE_END = 0x0, - NATIVE_TYPE_VOID = 0x1, - NATIVE_TYPE_BOOLEAN = 0x2, - NATIVE_TYPE_I1 = 0x3, - NATIVE_TYPE_U1 = 0x4, - NATIVE_TYPE_I2 = 0x5, - NATIVE_TYPE_U2 = 0x6, - NATIVE_TYPE_I4 = 0x7, - NATIVE_TYPE_U4 = 0x8, - NATIVE_TYPE_I8 = 0x9, - NATIVE_TYPE_U8 = 0xa, - NATIVE_TYPE_R4 = 0xb, - NATIVE_TYPE_R8 = 0xc, - NATIVE_TYPE_SYSCHAR = 0xd, - NATIVE_TYPE_VARIANT = 0xe, - NATIVE_TYPE_CURRENCY = 0xf, - NATIVE_TYPE_PTR = 0x10, - - NATIVE_TYPE_DECIMAL = 0x11, - NATIVE_TYPE_DATE = 0x12, - NATIVE_TYPE_BSTR = 0x13, - NATIVE_TYPE_LPSTR = 0x14, - NATIVE_TYPE_LPWSTR = 0x15, - NATIVE_TYPE_LPTSTR = 0x16, - NATIVE_TYPE_FIXEDSYSSTRING = 0x17, - NATIVE_TYPE_OBJECTREF = 0x18, - NATIVE_TYPE_IUNKNOWN = 0x19, - NATIVE_TYPE_IDISPATCH = 0x1a, - NATIVE_TYPE_STRUCT = 0x1b, - NATIVE_TYPE_INTF = 0x1c, - NATIVE_TYPE_SAFEARRAY = 0x1d, - NATIVE_TYPE_FIXEDARRAY = 0x1e, - NATIVE_TYPE_INT = 0x1f, - NATIVE_TYPE_UINT = 0x20, - - NATIVE_TYPE_NESTEDSTRUCT = 0x21, - NATIVE_TYPE_BYVALSTR = 0x22, - NATIVE_TYPE_ANSIBSTR = 0x23, - NATIVE_TYPE_TBSTR = 0x24, - NATIVE_TYPE_VARIANTBOOL = 0x25, - NATIVE_TYPE_FUNC = 0x26, - - NATIVE_TYPE_ASANY = 0x28, - NATIVE_TYPE_ARRAY = 0x2a, - NATIVE_TYPE_LPSTRUCT = 0x2b, - NATIVE_TYPE_CUSTOMMARSHALER = 0x2c, - NATIVE_TYPE_IINSPECTABLE = 0x2e, - NATIVE_TYPE_HSTRING = 0x2f, - - NATIVE_TYPE_ERROR = 0x2d, - - NATIVE_TYPE_MAX = 0x50 - -} CorNativeType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`NATIVE_TYPE_END`|Obsolete.| -|`NATIVE_TYPE_VOID`|Obsolete.| -|`NATIVE_TYPE_BOOLEAN`|A 4-byte Boolean value, where TRUE is non-zero and FALSE is zero.| -|`NATIVE_TYPE_I1`|A signed 8-bit integer value.| -|`NATIVE_TYPE_U1`|An unsigned 8-bit integer value.| -|`NATIVE_TYPE_I2`|A signed 16-bit integer value.| -|`NATIVE_TYPE_U2`|An unsigned 16-bit integer value.| -|`NATIVE_TYPE_I4`|A signed 32-bit integer value.| -|`NATIVE_TYPE_U4`|An unsigned 32-bit integer value.| -|`NATIVE_TYPE_I8`|A signed 64-bit integer value.| -|`NATIVE_TYPE_U8`|An unsigned 64-bit integer value.| -|`NATIVE_TYPE_R4`|A 4-byte floating-point numeric value.| -|`NATIVE_TYPE_R8`|An 8-byte floating-point numeric value.| -|`NATIVE_TYPE_SYSCHAR`|Obsolete.| -|`NATIVE_TYPE_VARIANT`|Obsolete.| -|`NATIVE_TYPE_CURRENCY`|A numeric COM type that corresponds to the managed type.| -|`NATIVE_TYPE_PTR`|Obsolete.| -|`NATIVE_TYPE_DECIMAL`|Obsolete.| -|`NATIVE_TYPE_DATE`|Obsolete.| -|`NATIVE_TYPE_BSTR`|COM Interop.| -|`NATIVE_TYPE_LPSTR`|An LPSTR string value.| -|`NATIVE_TYPE_LPWSTR`|An LPWSTR string value.| -|`NATIVE_TYPE_LPTSTR`|An LPTSTR string value.| -|`NATIVE_TYPE_FIXEDSYSSTRING`|A fixed, system-defined string value.| -|`NATIVE_TYPE_OBJECTREF`|Obsolete.| -|`NATIVE_TYPE_IUNKNOWN`|COM Interop.| -|`NATIVE_TYPE_IDISPATCH`|COM Interop.| -|`NATIVE_TYPE_STRUCT`|A native structure value.| -|`NATIVE_TYPE_INTF`|COM Interop.| -|`NATIVE_TYPE_SAFEARRAY`|COM Interop.| -|`NATIVE_TYPE_FIXEDARRAY`|A fixed-length array value.| -|`NATIVE_TYPE_INT`|A native 16-bit signed integer value.| -|`NATIVE_TYPE_UINT`|A native 16-bit unsigned integer value.| -|`NATIVE_TYPE_NESTEDSTRUCT`|Obsolete.

Use NATIVE_TYPE_STRUCT.| -|`NATIVE_TYPE_BYVALSTR`|COM Interop.| -|`NATIVE_TYPE_ANSIBSTR`|COM Interop.| -|`NATIVE_TYPE_TBSTR`|COM Interop.

Select BSTR or ANSIBSTR depending on the platform.| -|`NATIVE_TYPE_VARIANTBOOL`|A 2-byte Boolean value, where TRUE is -1 and FALSE is zero.| -|`NATIVE_TYPE_FUNC`|A function pointer.| -|`NATIVE_TYPE_ASANY`|A reference to any native type.| -|`NATIVE_TYPE_ARRAY`|A reference to an array with members of an unspecified type.| -|`NATIVE_TYPE_LPSTRUCT`|A 32-bit integer pointer to a structure.| -|`NATIVE_TYPE_CUSTOMMARSHALER`|A custom marshaller native type.

This must be followed by a string of the following format: "Native type name/0Custom marshaller type name/0Optional cookie/0" or "{Native type GUID}/0Custom marshaller type name/0Optional cookie/0"| -|`NATIVE_TYPE_ERROR`|COM Interop.

With ELEMENT_TYPE_I4 this type maps to VT_HRESULT.| -|`NATIVE_TYPE_IINSPECTABLE`|A native `IInspectable` type.| -|`NATIVE_TYPE_HSTRING`|A native `HString`.| -|`NATIVE_TYPE_MAX`|An invalid value.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md b/docs/framework/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md deleted file mode 100644 index 9608402958d92..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -description: "Learn more about: CorNotificationForTokenMovement Enumeration" -title: "CorNotificationForTokenMovement Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorNotificationForTokenMovement" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorNotificationForTokenMovement" -helpviewer_keywords: - - "CorNotificationForTokenMovement enumeration [.NET Framework metadata]" -ms.assetid: 1edd1670-976a-4fc8-bef7-7c41e60ad989 -topic_type: - - "apiref" ---- -# CorNotificationForTokenMovement Enumeration - -Specifies the notifications that will be sent to the metadata API client when a token remap occurs. - -## Syntax - -```cpp -typedef enum CorNotificationForTokenMovement { - - MDNotifyDefault = 0x0000000f, - MDNotifyAll = 0xffffffff, - MDNotifyNone = 0x00000000, - MDNotifyMethodDef = 0x00000001, - MDNotifyMemberRef = 0x00000002, - MDNotifyFieldDef = 0x00000004, - MDNotifyTypeRef = 0x00000008, - - MDNotifyTypeDef = 0x00000010, - MDNotifyParamDef = 0x00000020, - MDNotifyInterfaceImpl = 0x00000040, - MDNotifyProperty = 0x00000080, - MDNotifyEvent = 0x00000100, - MDNotifySignature = 0x00000200, - MDNotifyTypeSpec = 0x00000400, - MDNotifyCustomAttribute = 0x00000800, - MDNotifySecurityValue = 0x00001000, - MDNotifyPermission = 0x00002000, - MDNotifyModuleRef = 0x00004000, - - MDNotifyNameSpace = 0x00008000, - - MDNotifyAssemblyRef = 0x01000000, - MDNotifyFile = 0x02000000, - MDNotifyExportedType = 0x04000000, - MDNotifyResource = 0x08000000 - -} CorNotificationForTokenMovement; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MDNotifyDefault`|Notify when `mdTypeRef`, `mdMethodDef`, `mdMemberRef`, or `mdFieldDef` tokens move.| -|`MDNotifyAll`|Notify when any token moves.| -|`MDNotifyNone`|Do not notify when tokens move.| -|`MDNotifyMethodDef`|Notify when an `mdMethodDef` token moves.| -|`MDNotifyMemberRef`|Notify when an `mdMemberRef` token moves.| -|`MDNotifyFieldDef`|Notify when an `mdFieldDef` token moves.| -|`MDNotifyTypeRef`|Notify when an `mdTypeRef` token moves.| -|`MDNotifyTypeDef`|Notify when an `mdTypeDef` token moves.| -|`MDNotifyParamDef`|Notify when an `mdParamDef` token moves.| -|`MDNotifyInterfaceImpl`|Notify when an `mdInterfaceImpl` token moves.| -|`MDNotifyProperty`|Notify when an `mdProperty` token moves.| -|`MDNotifyEvent`|Notify when an `mdEvent` token moves.| -|`MDNotifySignature`|Notify when an `mdSignature` token moves.| -|`MDNotifyTypeSpec`|Notify when an `mdTypeSpec` token moves.| -|`MDNotifyCustomAttribute`|Notify when an `mdCustomAttribute` token moves.| -|`MDNotifySecurityValue`|Notify when an `mdSecurityValue` token moves.| -|`MDNotifyPermission`|Notify when an `mdPermission` token moves.| -|`MDNotifyModuleRef`|Notify when an `mdModuleRef` token moves.| -|`MDNotifyNameSpace`|Notify when an `mdNameSpace` token moves.| -|`MDNotifyAssemblyRef`|Notify when an `mdAssemblyRef` token moves.| -|`MDNotifyFile`|Notify when an `mdFile` token moves.| -|`MDNotifyExportedType`|Notify when an `mdExportedType` token moves.| -|`MDNotifyResource`|Notify when an `mdManifestResource` token moves.| - -## Remarks - - A token may be re-mapped (that is, moved) during a metadata merge. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/coropenflags-enumeration.md b/docs/framework/unmanaged-api/metadata/coropenflags-enumeration.md deleted file mode 100644 index 03457c9b0ceee..0000000000000 --- a/docs/framework/unmanaged-api/metadata/coropenflags-enumeration.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: CorOpenFlags Enumeration" -title: "CorOpenFlags Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorOpenFlags" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorOpenFlags" -helpviewer_keywords: - - "CorOpenFlags enumeration [.NET Framework metadata]" -ms.assetid: e27a83b5-2698-4996-9032-1e0fed8b91ca -topic_type: - - "apiref" ---- -# CorOpenFlags Enumeration - -Contains flag values that control metadata behavior upon opening manifest files. - -## Syntax - -```cpp -typedef enum CorOpenFlags -{ - ofRead = 0x00000000, - ofWrite = 0x00000001, - ofReadWriteMask = 0x00000001, - ofCopyMemory = 0x00000002, - ofCacheImage = 0x00000004, - ofManifestMetadata = 0x00000008, - ofReadOnly = 0x00000010, - ofTakeOwnership = 0x00000020, - ofCacheImage = 0x00000004, - ofNoTypeLib = 0x00000080, - ofNoTransform = 0x00001000, - ofReserved1 = 0x00000100, - ofReserved2 = 0x00000200, - ofReserved = 0xffffff40 -} CorOpenFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`ofRead`|Indicates that the file should be opened for reading only.| -|`ofWrite`|Indicates that the file should be opened for writing.

If you are using the `ofWrite` flag when opening a .winmd file, you should also pass the `ofNoTransform` flag.| -|`ofReadWriteMask`|A mask for reading and writing.| -|`ofCopyMemory`|Indicates that the file should be read into memory. Metadata should maintain its own copy.| -|`ofCacheImage`|Obsolete. This flag is ignored.| -|`ofManifestMetadata`|Obsolete. This flag is ignored.| -|`ofReadOnly`|Indicates that the file should be opened for reading, and that a call to `QueryInterface` for an [IMetaDataEmit](imetadataemit-interface.md) cannot be made.| -|`ofTakeOwnership`|Indicates that the memory was allocated using a call to [CoTaskMemAlloc](/windows/desktop/api/combaseapi/nf-combaseapi-cotaskmemalloc) and will be freed by the metadata.| -|`ofNoTypeLib`|Obsolete. This flag is ignored.| -|`ofNoTransform`|Indicates that automatic transforms of .winmd files should be disabled. In other words, the projection of a Windows Runtime type to a .NET Framework type should be disabled. For more information, see [Windows Runtime and the CLR - Underneath the Hood with .NET and the Windows Runtime](/archive/msdn-magazine/2012/windows-8-special-issue/windows-runtime-and-the-clr-underneath-the-hood-with-net-and-the-windows-runtime).| -|`ofReserved1`|Reserved for internal use.| -|`ofReserved2`|Reserved for internal use.| -|`ofReserved`|Reserved for internal use.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corparamattr-enumeration.md b/docs/framework/unmanaged-api/metadata/corparamattr-enumeration.md deleted file mode 100644 index 49f835e74ddef..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corparamattr-enumeration.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: "Learn more about: CorParamAttr Enumeration" -title: "CorParamAttr Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorParamAttr" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorParamAttr" -helpviewer_keywords: - - "CorParamAttr enumeration [.NET Framework metadata]" -ms.assetid: a7ff90ad-dad8-48e8-917d-4aa9a118cbc8 -topic_type: - - "apiref" ---- -# CorParamAttr Enumeration - -Contains values that describe the metadata of a method parameter. - -## Syntax - -```cpp -typedef enum CorParamAttr { - - pdIn = 0x0001, - pdOut = 0x0002, - pdOptional = 0x0010, - - pdReservedMask = 0xf000, - pdHasDefault = 0x1000, - pdHasFieldMarshal = 0x2000, - - pdUnused = 0xcfe0 - -} CorParamAttr; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`pdIn`|Specifies that the parameter is passed into the method call.| -|`pdOut`|Specifies that the parameter is passed from the method return.| -|`pdOptional`|Specifies that the parameter is optional.| -|`pdReservedMask`|Reserved for internal use by the common language runtime.| -|`pdHasDefault`|Specifies that the parameter has a default value.| -|`pdHasFieldMarshal`|Specifies that the parameter has marshalling information.| -|`pdUnused`|Unused.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corpekind-enumeration.md b/docs/framework/unmanaged-api/metadata/corpekind-enumeration.md deleted file mode 100644 index 4a2bfb1267208..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corpekind-enumeration.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: "Learn more about: CorPEKind Enumeration" -title: "CorPEKind Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorPEKind" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorPEKind" -helpviewer_keywords: - - "CorPEKind enumeration [.NET Framework metadata]" -ms.assetid: 22dc6dea-b1b9-4982-a730-a022d586b117 -topic_type: - - "apiref" ---- -# CorPEKind Enumeration - -Contains values that describe a portable executable (PE) file, as returned from a call to [IMetaDataImport2::GetPEKind](imetadataimport2-getpekind-method.md). - -## Syntax - -```cpp -typedef enum CorPEKind { - - peNot = 0x00000000, - peILonly = 0x00000001, - pe32BitRequired = 0x00000002, - pe32Plus = 0x00000004, - pe32Unmanaged = 0x00000008, - pe32BitPreferred= 0x00000010 - -} CorPEKind; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`peNot`|Indicates that this is not a PE file.| -|`peILOnly`|Indicates that this PE file contains only managed code.| -|`pe32BitRequired`|Indicates that this PE file makes Win32 calls.| -|`pe32Plus`|Indicates that this PE file runs on a 64-bit platform.| -|`pe32Unmanaged`|Indicates that this PE file is native code.| -|pe32BitPreferred|Indicates that this PE file is platform-neutral and prefers to be loaded in a 32-bit environment.| - -## Remarks - - These values can be used in bitwise combinations. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corpinvokemap-enumeration.md b/docs/framework/unmanaged-api/metadata/corpinvokemap-enumeration.md deleted file mode 100644 index 8ec4fa5780ab5..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corpinvokemap-enumeration.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -description: "Learn more about: CorPinvokeMap Enumeration" -title: "CorPinvokeMap Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorPinvokeMap" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorPinvokeMap" -helpviewer_keywords: - - "CorPinvokeMap enumeration [.NET Framework metadata]" -ms.assetid: f14f986e-f6ce-42bc-aa23-18150c46d28c -topic_type: - - "apiref" ---- -# CorPinvokeMap Enumeration - -Specifies options for a PInvoke call. - -## Syntax - -```cpp -typedef enum CorPinvokeMap { - - pmNoMangle = 0x0001, - - pmCharSetMask = 0x0006, - pmCharSetNotSpec = 0x0000, - pmCharSetAnsi = 0x0002, - pmCharSetUnicode = 0x0004, - pmCharSetAuto = 0x0006, - - pmBestFitUseAssem = 0x0000, - pmBestFitEnabled = 0x0010, - pmBestFitDisabled = 0x0020, - pmBestFitMask = 0x0030, - - pmThrowOnUnmappableCharUseAssem = 0x0000, - pmThrowOnUnmappableCharEnabled = 0x1000, - pmThrowOnUnmappableCharDisabled = 0x2000, - pmThrowOnUnmappableCharMask = 0x3000, - - pmSupportsLastError = 0x0040, - - pmCallConvMask = 0x0700, - pmCallConvWinapi = 0x0100, - pmCallConvCdecl = 0x0200, - pmCallConvStdcall = 0x0300, - pmCallConvThiscall = 0x0400, - pmCallConvFastcall = 0x0500, - - pmMaxValue = 0xFFFF - -} CorPinvokeMap; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`pmNoMangle`|Use each member name as specified.| -|`pmCharSetMask`|Reserved.| -|`pmCharSetNotSpec`|Reserved.| -|`pmCharSetAnsi`|Marshal strings as multiple-byte character strings.| -|`pmCharSetUnicode`|Marshal strings as Unicode 2-byte characters.| -|`pmCharSetAuto`|Automatically marshal strings appropriately for the target operating system. The default is Unicode on Windows.| -|`pmBestFitUseAssem`|Reserved.| -|`pmBestFitEnabled`|Perform best-fit mapping of Unicode characters that lack an exact match in the ANSI character set.| -|`pmBestFitDisabled`|Do not perform best-fit mapping of Unicode characters. In this case, all unmappable characters will be replaced by a ‘?’.| -|`pmBestFitMask`|Reserved.| -|`pmThrowOnUnmappableCharUseAssem`|Reserved.| -|`pmThrowOnUnmappableCharEnabled`|Throw an exception when the interop marshaller encounters an unmappable character.| -|`pmThrowOnUnmappableCharDisabled`|Do not throw an exception when the interop marshaller encounters an unmappable character.| -|`pmThrowOnUnmappableCharMask`|Reserved| -|`pmSupportsLastError`|Allow the callee to call the Win32 `SetLastError` function before returning from the attributed method.| -|`pmCallConvMask`|Reserved| -|`pmCallConvWinapi`|Use the default platform calling convention. For example, on Windows the default is `StdCall` and on Windows CE .NET it is `Cdecl`.| -|`pmCallConvCdecl`|Use the `Cdecl` calling convention. In this case, the caller cleans the stack. This enables calling functions with `varargs` (that is, functions that accept a variable number of parameters).| -|`pmCallConvStdcall`|Use the `StdCall` calling convention. In this case, the callee cleans the stack. This is the default convention for calling unmanaged functions with platform invoke.| -|`pmCallConvThiscall`|Use the `ThisCall` calling convention. In this case, the first parameter is the `this` pointer and is stored in register ECX. Other parameters are pushed on the stack. The `ThisCall` calling convention is used to call methods on classes exported from an unmanaged DLL.| -|`pmCallConvFastcall`|Reserved.| -|`pmMaxValue`|Reserved.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corpropertyattr-enumeration.md b/docs/framework/unmanaged-api/metadata/corpropertyattr-enumeration.md deleted file mode 100644 index 437b161b09f2a..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corpropertyattr-enumeration.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn more about: CorPropertyAttr Enumeration" -title: "CorPropertyAttr Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorPropertyAttr" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorPropertyAttr" -helpviewer_keywords: - - "CorPropertyAttr enumeration [.NET Framework metadata]" -ms.assetid: 58ac8202-854d-4efd-acfb-d2da8b446e12 -topic_type: - - "apiref" ---- -# CorPropertyAttr Enumeration - -Contains values that describe the metadata of a property. - -## Syntax - -```cpp -typedef enum CorPropertyAttr { - - prSpecialName = 0x0200, - prReservedMask = 0xf400, - prRTSpecialName = 0x0400, - prHasDefault = 0x1000, - prUnused = 0xe9ff - -} CorPropertyAttr; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`prSpecialName`|Specifies that the property is special, and that its name describes how.| -|`prReservedMask`|Reserved for internal use by the common language runtime.| -|`prRTSpecialName`|Specifies that the common language runtime metadata internal APIs should check the encoding of the property name.| -|`prHasDefault`|Specifies that the property has a default value.| -|`prUnused`|Unused.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/correftodefcheck-enumeration.md b/docs/framework/unmanaged-api/metadata/correftodefcheck-enumeration.md deleted file mode 100644 index e4006eda67309..0000000000000 --- a/docs/framework/unmanaged-api/metadata/correftodefcheck-enumeration.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: "Learn more about: CorRefToDefCheck Enumeration" -title: "CorRefToDefCheck Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorRefToDefCheck" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorRefToDefCheck" -helpviewer_keywords: - - "CorRefToDefCheck enumeration [.NET Framework metadata]" -ms.assetid: f9a80f1a-55af-4459-b095-8441aae16119 -topic_type: - - "apiref" ---- -# CorRefToDefCheck Enumeration - -Specifies flags to control which referenced items are converted to their definitions in order to optimize the code. - -## Syntax - -```cpp -typedef enum CorRefToDefCheck { - MDRefToDefDefault = 0x00000003, - MDRefToDefAll = 0xffffffff, - MDRefToDefNone = 0x00000000, - MDTypeRefToDef = 0x00000001, - MDMemberRefToDef = 0x00000002 -} CorRefToDefCheck; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MDRefToDefDefault`|Specifies that type references and member references should be converted to definitions. This is the default value (`MDTypeRefToDef` | `MDMemberRefToDef`).| -|`MDRefToDefAll`|Specifies that all referenced items should be converted to definitions.| -|`MDRefToDefNone`|Specifies that no referenced items should be converted to definitions.| -|`MDTypeRefToDef`|Specifies that only type references should be converted to type definitions.| -|`MDMemberRefToDef`|Specifies that only member references should be converted to definitions. That is, member references should be converted to either method definitions or field definitions.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corregflags-enumeration.md b/docs/framework/unmanaged-api/metadata/corregflags-enumeration.md deleted file mode 100644 index 4a37c7c0cbf47..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corregflags-enumeration.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: CorRegFlags Enumeration" -title: "CorRegFlags Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorRegFlags" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorRegFlags" -helpviewer_keywords: - - "CorRegFlags enumeration [.NET Framework metadata]" -ms.assetid: 8d3080ee-39fe-4c57-8950-51323632d045 -topic_type: - - "apiref" ---- -# CorRegFlags Enumeration - -Provides flag values used for registration when installing a module or composite image. - -## Syntax - -```cpp -typedef enum -{ - regNoCopy = 0x00000001, - regConfig = 0x00000002, - regHasRefs = 0x00000004 -} CorRegFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`regNoCopy`|Specifies that files should not be copied into the destination.| -|`regConfig`|Specifies that the module or composite is a configuration.| -|`regHasRefs`|Specifies that the module or composite has class references.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corsavesize-enumeration.md b/docs/framework/unmanaged-api/metadata/corsavesize-enumeration.md deleted file mode 100644 index fdd8f6aaa4dc7..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corsavesize-enumeration.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: "Learn more about: CorSaveSize Enumeration" -title: "CorSaveSize Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorSaveSize" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorSaveSize" -helpviewer_keywords: - - "CorSaveSize enumeration [.NET Framework metadata]" -ms.assetid: eb95ce39-5688-43c1-a34d-578794b32faa -topic_type: - - "apiref" ---- -# CorSaveSize Enumeration - -Contains values indicating the level of precision required when querying for the size of a save operation. - -## Syntax - -```cpp -typedef enum CorSaveSize { - cssAccurate = 0x0000, - cssQuick = 0x0001, - cssDiscardTransientCAs = 0x0002 -} CorSaveSize; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`cssAccurate`|Specifies that the return value should be exact.| -|`cssQuick`|Specifies that the return value should be estimated.| -|`cssDiscardTransientCAs`|Specifies that discardable types should be removed.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corserializationtype-enumeration.md b/docs/framework/unmanaged-api/metadata/corserializationtype-enumeration.md deleted file mode 100644 index 5f0b510eecfa5..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corserializationtype-enumeration.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -description: "Learn more about: CorSerializationType Enumeration" -title: "CorSerializationType Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorSerializationType" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorSerializationType" -helpviewer_keywords: - - "CorSerializationType enumeration [.NET Framework metadata]" -ms.assetid: 6b1fcd11-c7fb-4be2-8910-abc862d4caf4 -topic_type: - - "apiref" ---- -# CorSerializationType Enumeration - -Specifies how an object is serialized by the common language runtime. - -## Syntax - -```cpp -typedef enum CorSerializationType { - - SERIALIZATION_TYPE_UNDEFINED = 0, - SERIALIZATION_TYPE_BOOLEAN = ELEMENT_TYPE_BOOLEAN, - SERIALIZATION_TYPE_CHAR = ELEMENT_TYPE_CHAR, - SERIALIZATION_TYPE_I1 = ELEMENT_TYPE_I1, - SERIALIZATION_TYPE_U1 = ELEMENT_TYPE_U1, - SERIALIZATION_TYPE_I2 = ELEMENT_TYPE_I2, - SERIALIZATION_TYPE_U2 = ELEMENT_TYPE_U2, - SERIALIZATION_TYPE_I4 = ELEMENT_TYPE_I4, - SERIALIZATION_TYPE_U4 = ELEMENT_TYPE_U4, - SERIALIZATION_TYPE_I8 = ELEMENT_TYPE_I8, - SERIALIZATION_TYPE_U8 = ELEMENT_TYPE_U8, - SERIALIZATION_TYPE_R4 = ELEMENT_TYPE_R4, - SERIALIZATION_TYPE_R8 = ELEMENT_TYPE_R8, - SERIALIZATION_TYPE_STRING = ELEMENT_TYPE_STRING, - SERIALIZATION_TYPE_SZARRAY = ELEMENT_TYPE_SZARRAY, - SERIALIZATION_TYPE_TYPE = 0x50, - SERIALIZATION_TYPE_TAGGED_OBJECT = 0x51, - SERIALIZATION_TYPE_FIELD = 0x53, - SERIALIZATION_TYPE_PROPERTY = 0x54, - SERIALIZATION_TYPE_ENUM = 0x55 - -} CorSerializationType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`SERIALIZATION_TYPE_UNDEFINED`|Serialization of the object is undefined.| -|`SERIALIZATION_TYPE_BOOLEAN`|Object is serialized as a Boolean type| -|`SERIALIZATION_TYPE_CHAR`|Object is serialized as a character type.| -|`SERIALIZATION_TYPE_I1`|Object is serialized as a signed 1-byte integer.| -|`SERIALIZATION_TYPE_U1`|Object is serialized as an unsigned 1-byte integer.| -|`SERIALIZATION_TYPE_I2`|Object is serialized as a signed 2-byte integer.| -|`SERIALIZATION_TYPE_U2`|Object is serialized as an unsigned 2-byte integer.| -|`SERIALIZATION_TYPE_I4`|Object is serialized as a signed 4-byte integer.| -|`SERIALIZATION_TYPE_U4`|Object is serialized as an unsigned 4-byte integer.| -|`SERIALIZATION_TYPE_I8`|Object is serialized as a signed 8-byte integer.| -|`SERIALIZATION_TYPE_U8`|Object is serialized as an unsigned 8-byte integer.| -|`SERIALIZATION_TYPE_R4`|Object is serialized as a 4-byte floating point.| -|`SERIALIZATION_TYPE_R8`|Object is serialized as an 8-byte floating point.| -|`SERIALIZATION_TYPE_STRING`|Object is serialized as a System.String type.| -|`SERIALIZATION_TYPE_SZARRAY`|Object is serialized as a single-dimensional, zero lower-bound array.| -|`SERIALIZATION_TYPE_TYPE`|Object is serialized as a generic type.| -|`SERIALIZATION_TYPE_TAGGED_OBJECT`|Object is serialized as a tagged object.| -|`SERIALIZATION_TYPE_FIELD`|Object is serialized as a field.| -|`SERIALIZATION_TYPE_PROPERTY`|Object is serialized as a property.| -|`SERIALIZATION_TYPE_ENUM`|Object is serialized as an enumeration.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corsetenc-enumeration.md b/docs/framework/unmanaged-api/metadata/corsetenc-enumeration.md deleted file mode 100644 index 37f4c50083458..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corsetenc-enumeration.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -description: "Learn more about: CorSetENC Enumeration" -title: "CorSetENC Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorSetENC" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorSetENC" -helpviewer_keywords: - - "CorSetENC enumeration [.NET Framework metadata]" -ms.assetid: fe4150e8-071d-43fb-8e06-c3c616dbeed2 -topic_type: - - "apiref" ---- -# CorSetENC Enumeration - -Contains values used to influence behavior during the generation of metadata. - -## Syntax - -```cpp -typedef enum CorSetENC { - - MDSetENCOn = 0x00000001, - MDSetENCOff = 0x00000002, - - MDUpdateENC = 0x00000001, - MDUpdateFull = 0x00000002, - MDUpdateExtension = 0x00000003, - MDUpdateIncremental = 0x00000004, - MDUpdateDelta = 0x00000005, - MDUpdateMask = 0x00000007 - -} CorSetENC; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MDSetENCOn`|Obsolete.| -|`MDSetENCOff`|Obsolete.| -|`MDUpdateENC`|Indicates that whereas metadata can be updated, tokens cannot be moved.| -|`MDUpdateFull`|Indicates that tokens can be moved during updates.| -|`MDUpdateExtension`|Indicates that updates can consist only of additions. Tokens cannot be moved.| -|`MDUpdateIncremental`|Indicates that compilation is incremental.| -|`MDUpdateDelta`|Indicates that only changed metadata should be saved.| -|`MDUpdateMask`|Includes `MDUpdateENC`, `MDUpdateFull` and `MDUpdateIncremental`.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cortokentype-enumeration.md b/docs/framework/unmanaged-api/metadata/cortokentype-enumeration.md deleted file mode 100644 index bbfb6d5bd0da9..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cortokentype-enumeration.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -description: "Learn more about: CorTokenType Enumeration" -title: "CorTokenType Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorTokenType" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorTokenType" -helpviewer_keywords: - - "CorTokenType enumeration [.NET Framework metadata]" -ms.assetid: 93c9a369-225f-4eff-9b78-3fbee4902cf1 -topic_type: - - "apiref" ---- -# CorTokenType Enumeration - -Indicates the type of a metadata token. - -## Syntax - -```cpp -typedef enum CorTokenType { - - mdtModule = 0x00000000, - mdtTypeRef = 0x01000000, - mdtTypeDef = 0x02000000, - mdtFieldDef = 0x04000000, - mdtMethodDef = 0x06000000, - mdtParamDef = 0x08000000, - mdtInterfaceImpl = 0x09000000, - mdtMemberRef = 0x0a000000, - mdtCustomAttribute = 0x0c000000, - mdtPermission = 0x0e000000, - mdtSignature = 0x11000000, - mdtEvent = 0x14000000, - mdtProperty = 0x17000000, - mdtModuleRef = 0x1a000000, - mdtTypeSpec = 0x1b000000, - mdtAssembly = 0x20000000, - mdtAssemblyRef = 0x23000000, - mdtFile = 0x26000000, - mdtExportedType = 0x27000000, - mdtManifestResource = 0x28000000, - mdtGenericParam = 0x2a000000, - mdtMethodSpec = 0x2b000000, - mdtGenericParamConstraint = 0x2c000000, - mdtString = 0x70000000, - mdtName = 0x71000000, - mdtBaseType = 0x72000000 - -} CorTokenType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`mdtModule`|An `mdModule` token.| -|`mdtTypeRef`|An `mdTypeRef` token.| -|`mdtTypeDef`|An `mdTypeDef` token.| -|`mdtFieldDef`|An `mdFieldDef` token.| -|`mdtMethodDef`|An `mdMethodDef` token.| -|`mdtParamDef`|An `mdParamDef` token.| -|`mdtInterfaceImpl`|An `mdInterfaceImpl` token.| -|`mdtMemberRef`|An `mdMemberRef` token.| -|`mdtCustomAttribute`|An `mdCustomAttribute` token.| -|`mdtPermission`|An `mdPermission` token.| -|`mdtSignature`|An `mdSignature` token.| -|`mdtEvent`|An `mdEvent` token.| -|`mdtProperty`|An `mdProperty` token.| -|`mdtModuleRef`|An `mdModuleRef` token.| -|`mdtTypeSpec`|An `mdTypeSpec` token.| -|`mdtAssembly`|An `mdAssembly` token.| -|`mdtAssemblyRef`|An `mdAssemblyRef` token.| -|`mdtFile`|An `mdFile` token.| -|`mdtExportedType`|An `mdExportedType` token.| -|`mdtManifestResource`|An `mdManifestResource` token.| -|`mdtGenericParam`|An `mdGenericParam` token.| -|`mdtMethodSpec`|An `mdMethodSpec` token.| -|`mdtGenericParamConstraint`|An `mdGenericParamConstraint` token.| -|`mdtString`|An `mdString` token.| -|`mdtName`|An `mdName` token.| -|`mdtBaseType`|Not used.| - -## Remarks - - Each value is equal to the value of the top byte in the corresponding metadata token. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cortypeattr-enumeration.md b/docs/framework/unmanaged-api/metadata/cortypeattr-enumeration.md deleted file mode 100644 index 3a5f54f6a7f3f..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cortypeattr-enumeration.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -description: "Learn more about: CorTypeAttr Enumeration" -title: "CorTypeAttr Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorTypeAttr" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorTypeAttr" -helpviewer_keywords: - - "CorTypeAttr enumeration [.NET Framework metadata]" -ms.assetid: 9bede0ec-5fdf-42a2-b5b7-bee64056acb6 -topic_type: - - "apiref" ---- -# CorTypeAttr Enumeration - -Contains values that indicate type metadata. - -## Syntax - -```cpp -typedef enum CorTypeAttr { - - tdVisibilityMask = 0x00000007, - tdNotPublic = 0x00000000, - tdPublic = 0x00000001, - tdNestedPublic = 0x00000002, - tdNestedPrivate = 0x00000003, - tdNestedFamily = 0x00000004, - tdNestedAssembly = 0x00000005, - tdNestedFamANDAssem = 0x00000006, - tdNestedFamORAssem = 0x00000007, - - tdLayoutMask = 0x00000018, - tdAutoLayout = 0x00000000, - tdSequentialLayout = 0x00000008, - tdExplicitLayout = 0x00000010, - - tdClassSemanticsMask = 0x00000020, - tdClass = 0x00000000, - tdInterface = 0x00000020, - - tdAbstract = 0x00000080, - tdSealed = 0x00000100, - tdSpecialName = 0x00000400, - - tdImport = 0x00001000, - tdSerializable = 0x00002000, - tdWindowsRuntime = 0x00004000, - - tdStringFormatMask = 0x00030000, - tdAnsiClass = 0x00000000, - tdUnicodeClass = 0x00010000, - tdAutoClass = 0x00020000, - tdCustomFormatClass = 0x00030000, - tdCustomFormatMask = 0x00C00000, - - tdBeforeFieldInit = 0x00100000, - tdForwarder = 0x00200000, - - tdReservedMask = 0x00040800, - tdRTSpecialName = 0x00000800, - tdHasSecurity = 0x00040000, - -} CorTypeAttr; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`tdVisibilityMask`|Used for type visibility information.| -|`tdNotPublic`|Specifies that the type is not in public scope.| -|`tdPublic`|Specifies that the type is in public scope.| -|`tdNestedPublic`|Specifies that the type is nested with public visibility.| -|`tdNestedPrivate`|Specifies that the type is nested with private visibility.| -|`tdNestedFamily`|Specifies that the type is nested with family visibility.| -|`tdNestedAssembly`|Specifies that the type is nested with assembly visibility.| -|`tdNestedFamANDAssem`|Specifies that the type is nested with family and assembly visibility.| -|`tdNestedFamORAssem`|Specifies that the type is nested with family or assembly visibility.| -|`tdLayoutMask`|Gets layout information for the type.| -|`tdAutoLayout`|Specifies that the fields of this type are laid out automatically.| -|`tdSequentialLayout`|Specifies that the fields of this type are laid out sequentially.| -|`tdExplicitLayout`|Specifies that field layout is supplied explicitly.| -|`tdClassSemanticsMask`|Gets semantic information about the type.| -|`tdClass`|Specifies that the type is a class.| -|`tdInterface`|Specifies that the type is an interface.| -|`tdAbstract`|Specifies that the type is abstract.| -|`tdSealed`|Specifies that the type cannot be extended.| -|`tdSpecialName`|Specifies that the class name is special. Its name describes how.| -|`tdImport`|Specifies that the type is imported.| -|`tdSerializable`|Specifies that the type is serializable.| -|`tdWindowsRuntime`|Specifies that this type is a Windows Runtime type.| -|`tdStringFormatMask`|Gets information about how strings are encoded and formatted.| -|`tdAnsiClass`|Specifies that this type interprets an LPTSTR as ANSI.| -|`tdUnicodeClass`|Specifies that this type interprets an LPTSTR as Unicode.| -|`tdAutoClass`|Specifies that this type interprets an LPTSTR automatically.| -|`tdCustomFormatClass`|Specifies that the type has a non-standard encoding, as specified by `CustomFormatMask`.| -|`tdCustomFormatMask`|Use this mask to get non-standard encoding information for native interop. The meaning of the values of these two bits is unspecified.| -|`tdBeforeFieldInit`|Specifies that the type must be initialized before the first attempt to access a static field.| -|`tdForwarder`|Specifies that the type is exported, and a type forwarder.| -|`tdReservedMask`|This flag and the flags below are used internally by the common language runtime.| -|`tdRTSpecialName`|Specifies that the common language runtime should check the name encoding.| -|`tdHasSecurity`|Specifies that the type has security associated with it.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md b/docs/framework/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md deleted file mode 100644 index 9b2eb6013d0df..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -description: "Learn more about: CorUnmanagedCallingConvention Enumeration" -title: "CorUnmanagedCallingConvention Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorUnmanagedCallingConvention" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorUnmanagedCallingConvention" -helpviewer_keywords: - - "CorUnmanagedCallingConvention enumeration [.NET Framework metadata]" -ms.assetid: 83058790-160b-4703-a5eb-74b66acbdfa9 -topic_type: - - "apiref" ---- -# CorUnmanagedCallingConvention Enumeration - -Specifies the calling conventions for unmanaged code. - -## Syntax - -```cpp -typedef enum CorUnmanagedCallingConvention { - - IMAGE_CEE_UNMANAGED_CALLCONV_C = 0x1, - IMAGE_CEE_UNMANAGED_CALLCONV_STDCALL = 0x2, - IMAGE_CEE_UNMANAGED_CALLCONV_THISCALL = 0x3, - IMAGE_CEE_UNMANAGED_CALLCONV_FASTCALL = 0x4, - - IMAGE_CEE_CS_CALLCONV_C = 0x1, - IMAGE_CEE_CS_CALLCONV_STDCALL = 0x2, - IMAGE_CEE_CS_CALLCONV_THISCALL = 0x3, - IMAGE_CEE_CS_CALLCONV_FASTCALL = 0x4 - -} CorUnmanagedCallingConvention; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`IMAGE_CEE_UNMANAGED_CALLCONV_C`|The C language calling convention.| -|`IMAGE_CEE_UNMANAGED_CALLCONV_STDCALL`|The standard calling convention.| -|`IMAGE_CEE_UNMANAGED_CALLCONV_THISCALL`|The "this" calling convention.| -|`IMAGE_CEE_UNMANAGED_CALLCONV_FASTCALL`|The "fast" calling convention.| -|`IMAGE_CEE_CS_CALLCONV_C`|Not used.| -|`IMAGE_CEE_CS_CALLCONV_STDCALL`|Not used.| -|`IMAGE_CEE_CS_CALLCONV_THISCALL`|Not used.| -|`IMAGE_CEE_CS_CALLCONV_FASTCALL`|Not used.| - -## Remarks - - The CLR does not support the "fast" calling convention in .NET Framework version 1.0. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorHdr.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md b/docs/framework/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md deleted file mode 100644 index 05daa1dd0a3eb..0000000000000 --- a/docs/framework/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: "Learn more about: CorValidatorModuleType Enumeration" -title: "CorValidatorModuleType Enumeration" -ms.date: "03/30/2017" -api_name: - - "CorValidatorModuleType" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorValidatorModuleType" -helpviewer_keywords: - - "CorValidatorModuleType enumeration [.NET Framework metadata]" -ms.assetid: 748f1ab2-fbcb-4f55-89ec-8d23d81ebc80 -topic_type: - - "apiref" ---- -# CorValidatorModuleType Enumeration - -Specifies the type of a module. - -## Syntax - -```cpp -typedef enum -{ - ValidatorModuleTypeInvalid = 0x0, - ValidatorModuleTypeMin = 0x00000001, - ValidatorModuleTypePE = 0x00000001, - ValidatorModuleTypeObj = 0x00000002, - ValidatorModuleTypeEnc = 0x00000003, - ValidatorModuleTypeIncr = 0x00000004, - ValidatorModuleTypeMax = 0x00000004 -} CorValidatorModuleType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`ValidatorModuleTypeInvalid`|The module is an invalid type.| -|`ValidatorModuleTypeMin`|The minimum value of the `CorValidatorModuleType` enum.| -|`ValidatorModuleTypePE`|The module is a portable executable (PE) file.| -|`ValidatorModuleTypeObj`|The module is a .obj file.| -|`ValidatorModuleTypeEnc`|The module is an edit-and-continue debugger session.| -|`ValidatorModuleTypeIncr`|The module is one that has been incrementally built.| -|`ValidatorModuleTypeMax`|The maximum value of the `CorValidatorModuleType` enum.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/couninitiee-enumeration.md b/docs/framework/unmanaged-api/metadata/couninitiee-enumeration.md deleted file mode 100644 index 95bae9b6812c2..0000000000000 --- a/docs/framework/unmanaged-api/metadata/couninitiee-enumeration.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: "Learn more about: COUNINITIEE Enumeration" -title: "COUNINITIEE Enumeration" -ms.date: "03/30/2017" -api_name: - - "COUNINITIEE" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "COUNINITIEE" -helpviewer_keywords: - - "COUNINITIEE enumeration [.NET Framework metadata]" -ms.assetid: c42baa79-f469-4330-95a2-baf7f021c2fc -topic_type: - - "apiref" ---- -# COUNINITIEE Enumeration - -Specifies constants used by [CoUninitializeEE](../hosting/couninitializeee-function.md) when initializing the common language runtime. - -## Syntax - -```cpp -typedef enum tagCOUNINITEE -{ - COUNINITEE_DEFAULT = 0x0, - COUNINITEE_DLL = 0x1 -} COUNINITIEE; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`COUNINITEE_DEFAULT`|Indicates default uninitialization mode.| -|`COUNINITEE_DLL`|Indicates uninitialization mode for unloading an assembly.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/framework/unmanaged-api/metadata/cvstruct-structure.md b/docs/framework/unmanaged-api/metadata/cvstruct-structure.md deleted file mode 100644 index 16c04fa3f013c..0000000000000 --- a/docs/framework/unmanaged-api/metadata/cvstruct-structure.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: "Learn more about: CVStruct Structure" -title: "CVStruct Structure" -ms.date: "03/30/2017" -api_name: - - "CVStruct" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CVStruct" -helpviewer_keywords: - - "CVStruct structure [.NET Framework metadata]" -ms.assetid: e9e4e497-d5fb-464b-991c-3bdd824664fd -topic_type: - - "apiref" ---- -# CVStruct Structure - -Contains information that is used when installing a module or a composite image. - -## Syntax - -```cpp -typedef struct { - short Major; - short Minor; - short Sub; - short Build; -} CVStruct; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|Major|Major version build number.| -|Minor|Minor version build number.| -|Sub|Sub-build number.| -|Build|Build number.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Structures](metadata-structures.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-addsectionreloc-method.md b/docs/framework/unmanaged-api/metadata/iceegen-addsectionreloc-method.md deleted file mode 100644 index 95ed816a79473..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-addsectionreloc-method.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: "Learn more about: ICeeGen::AddSectionReloc Method" -title: "ICeeGen::AddSectionReloc Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.AddSectionReloc" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::AddSectionReloc" -helpviewer_keywords: - - "AddSectionReloc method [.NET Framework metadata]" - - "ICeeGen::AddSectionReloc method [.NET Framework metadata]" -ms.assetid: b500a260-1d57-4953-95e1-c27063f7c8da -topic_type: - - "apiref" ---- -# ICeeGen::AddSectionReloc Method - -Adds a .reloc instruction to the code base. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT AddSectionReloc ( - [in] HCEESECTION section, - [in] ULONG offset, - [in] HCEESECTION relativeTo, - [in] CeeSectionRelocType relocType -); -``` - -## Parameters - - `section` - [in] The section of in-memory code to which to add a .reloc instruction. - - `offset` - [in] The offset of the section. - - `relativeTo` - [in] The section to which `offset` refers. - - `relocType` - [in] One of the [CeeSectionRelocType](ceesectionreloctype-enumeration.md) values, indicating the kind of .reloc instruction to add. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md b/docs/framework/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md deleted file mode 100644 index d145dcd0c7469..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: "Learn more about: ICeeGen::AllocateMethodBuffer Method" -title: "ICeeGen::AllocateMethodBuffer Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.AllocateMethodBuffer" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::AllocateMethodBuffer" -helpviewer_keywords: - - "AllocateMethodBuffer method [.NET Framework metadata]" - - "ICeeGen::AllocateMethodBuffer method [.NET Framework metadata]" -ms.assetid: 845ab77e-9639-47f5-99fb-f3b619e3e779 -topic_type: - - "apiref" ---- -# ICeeGen::AllocateMethodBuffer Method - -Creates a buffer of the specified size for a method, and gets the relative virtual address of the method. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT AllocateMethodBuffer ( - [in] ULONG cchBuffer, - [out] UCHAR **lpBuffer, - [out] ULONG *RVA -); -``` - -## Parameters - - `cchBuffer` - [in] The length of the buffer to create. - - `lpBuffer` - [out] The returned buffer. - - `RVA` - [out] The relative virtual address of the method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-computepointer-method.md b/docs/framework/unmanaged-api/metadata/iceegen-computepointer-method.md deleted file mode 100644 index cdd84f9b56401..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-computepointer-method.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: "Learn more about: ICeeGen::ComputePointer Method" -title: "ICeeGen::ComputePointer Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.ComputePointer" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::ComputePointer" -helpviewer_keywords: - - "ICeeGen::ComputePointer method [.NET Framework metadata]" - - "ComputePointer method [.NET Framework metadata]" -ms.assetid: b6b95c04-0f2c-4fcc-a8bc-3b1dcbdba731 -topic_type: - - "apiref" ---- -# ICeeGen::ComputePointer Method - -Determines the buffer for the specified code section. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT ComputePointer ( - [in] HCEESECTION section, - [in] ULONG RVA, - [out] UCHAR **lpBuffer -); -``` - -## Parameters - - `section` - [in] The code section for which to return a buffer. - - `RVA` - [in] The relative virtual address of the method for which to get a pointer. - - `lpBuffer` - [out] A pointer to the returned buffer. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-emitstring-method.md b/docs/framework/unmanaged-api/metadata/iceegen-emitstring-method.md deleted file mode 100644 index ce6cded8f66cb..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-emitstring-method.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: "Learn more about: ICeeGen::EmitString Method" -title: "ICeeGen::EmitString Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.EmitString" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::EmitString" -helpviewer_keywords: - - "EmitString method [.NET Framework metadata]" - - "ICeeGen::EmitString method [.NET Framework metadata]" -ms.assetid: ad2710a7-edb8-4493-8619-3fce235e3334 -topic_type: - - "apiref" ---- -# ICeeGen::EmitString Method - -Emits the specified string into the code base. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT EmitString ( - [in] LPWSTR lpString, - [out] ULONG *RVA -); -``` - -## Parameters - - `lpString` - [in] The string to emit. - - `RVA` - [out] The relative virtual address of the emitted string. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-generateceefile-method.md b/docs/framework/unmanaged-api/metadata/iceegen-generateceefile-method.md deleted file mode 100644 index 9741153fe9718..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-generateceefile-method.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GenerateCeeFile Method" -title: "ICeeGen::GenerateCeeFile Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GenerateCeeFile" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GenerateCeeFile" -helpviewer_keywords: - - "GenerateCeeFile method [.NET Framework metadata]" - - "ICeeGen::GenerateCeeFile method [.NET Framework metadata]" -ms.assetid: cca4a9a1-731b-4411-9e04-00cffe7a56d8 -topic_type: - - "apiref" ---- -# ICeeGen::GenerateCeeFile Method - -Generates a code-base file that contains the code base currently loaded into this [ICeeGen](iceegen-interface.md) interface. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GenerateCeeFile (); -``` - -## Parameters - - `GenerateCeeFile` takes no parameters. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md b/docs/framework/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md deleted file mode 100644 index cd14bdc9cb0ed..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GenerateCeeMemoryImage Method" -title: "ICeeGen::GenerateCeeMemoryImage Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GenerateCeeMemoryImage" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GenerateCeeMemoryImage" -helpviewer_keywords: - - "ICeeGen::GenerateCeeMemoryImage method [.NET Framework metadata]" - - "GenerateCeeMemoryImage method [.NET Framework metadata]" -ms.assetid: b3847495-0ae6-4a72-b496-65ce2424afc6 -topic_type: - - "apiref" ---- -# ICeeGen::GenerateCeeMemoryImage Method - -Generates an image in memory for the code base. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GenerateCeeMemoryImage ( - [out] void **ppImage -); -``` - -## Parameters - - `ppImage` - [out] A pointer to the generated image. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getilsection-method.md b/docs/framework/unmanaged-api/metadata/iceegen-getilsection-method.md deleted file mode 100644 index 0b92b49acbd5c..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-getilsection-method.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GetIlSection Method" -title: "ICeeGen::GetIlSection Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GetIlSection" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GetIlSection" -helpviewer_keywords: - - "GetIlSection method [.NET Framework metadata]" - - "ICeeGen::GetIlSection method [.NET Framework metadata]" -ms.assetid: 6f2db2ca-203f-4ac3-9530-208642ca385e -topic_type: - - "apiref" ---- -# ICeeGen::GetIlSection Method - -Gets the section of the intermediate language code base referenced by the specified handle. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GetIlSection ( - [in] HCEESECTION *section -); -``` - -## Parameters - - `section` - [in] The handle to the section to get. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md b/docs/framework/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md deleted file mode 100644 index 7ec1193599ea5..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GetIMapTokenIface Method" -title: "ICeeGen::GetIMapTokenIface Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GetIMapTokenIface" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GetIMapTokenIface" -helpviewer_keywords: - - "GetIMapTokenIface method [.NET Framework metadata]" - - "ICeeGen::GetIMapTokenIface method [.NET Framework metadata]" -ms.assetid: 847a5531-c37d-49cd-8844-9e54b5d86cf7 -topic_type: - - "apiref" ---- -# ICeeGen::GetIMapTokenIface Method - -Gets the interface referenced by the specified token. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GetIMapTokenIface ( - [in, out] IUnknown **pIMapToken -); -``` - -## Parameters - - `pIMapToken` - [in, out] The metadata token for the interface to be returned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md b/docs/framework/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md deleted file mode 100644 index 9cfdc734eac4c..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GetMethodBuffer Method" -title: "ICeeGen::GetMethodBuffer Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GetMethodBuffer" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GetMethodBuffer" -helpviewer_keywords: - - "ICeeGen::GetMethodBuffer method [.NET Framework metadata]" - - "GetMethodBuffer method [.NET Framework metadata]" -ms.assetid: c7c5b39a-d4ac-41f1-9d1e-44163f563a49 -topic_type: - - "apiref" ---- -# ICeeGen::GetMethodBuffer Method - -Gets a buffer of the appropriate size for the method at the specified relative virtual address. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GetMethodBuffer ( - [in] ULONG RVA, - [out] UCHAR **lpBuffer -); -``` - -## Parameters - - `RVA` - [in] The relative virtual address of the method for which to return a buffer. - - `lpBuffer` - [out] A pointer to the returned buffer. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getsectionblock-method.md b/docs/framework/unmanaged-api/metadata/iceegen-getsectionblock-method.md deleted file mode 100644 index 0107e4834bdfa..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-getsectionblock-method.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GetSectionBlock Method" -title: "ICeeGen::GetSectionBlock Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GetSectionBlock" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GetSectionBlock" -helpviewer_keywords: - - "GetSectionBlock method [.NET Framework metadata]" - - "ICeeGen::GetSectionBlock method [.NET Framework metadata]" -ms.assetid: 05c78aaf-5bbd-497e-9ae2-55f4fae0c5fb -topic_type: - - "apiref" ---- -# ICeeGen::GetSectionBlock Method - -Gets a section block of the code base. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GetSectionBlock ( - [in] HCEESECTION section, - [in] ULONG len, - [in] ULONG align = 1, - [out] void **ppBytes = 0 -); -``` - -## Parameters - - `section` - [in] The section from which to retrieve a block of the code base. - - `len` - [in] The length of the block to be retrieved. - - `align` - [in] The byte, relative to the beginning of the section, with which to align the first byte of the block. This is the position of the block within the section. - - `ppBytes` - [out] A pointer to a location that receives the address of the retrieved block. - -## Remarks - - Call `GetSectionBlock` only if you have special section requirements that are not handled by other methods. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getsectioncreate-method.md b/docs/framework/unmanaged-api/metadata/iceegen-getsectioncreate-method.md deleted file mode 100644 index 79a9961ce3ea6..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-getsectioncreate-method.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GetSectionCreate Method" -title: "ICeeGen::GetSectionCreate Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GetSectionCreate" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GetSectionCreate" -helpviewer_keywords: - - "ICeeGen::GetSectionCreate method [.NET Framework metadata]" - - "GetSectionCreate method [.NET Framework metadata]" -ms.assetid: 154b2460-59ce-4874-a9f2-1b3353486ac5 -topic_type: - - "apiref" ---- -# ICeeGen::GetSectionCreate Method - -Generates and gets a code section using the specified name and flag values. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GetSectionCreate ( - [in] const char *name, - [in] DWORD flags, - [out] HCEESECTION *section -); -``` - -## Parameters - - `name` - [in] A pointer to a string that specifies the name of the section to be created. - - `flags` - [in] Flags that specify options. - - `section` - [out] A pointer to the newly created code section. - -## Remarks - - Call `GetSectionCreate` only if you have special section requirements that are not handled by other methods. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md b/docs/framework/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md deleted file mode 100644 index 8b60d59982a3b..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GetSectionDataLen Method" -title: "ICeeGen::GetSectionDataLen Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GetSectionDataLen" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GetSectionDataLen" -helpviewer_keywords: - - "ICeeGen::GetSectionDataLen method [.NET Framework metadata]" - - "GetSectionDataLen method [.NET Framework metadata]" -ms.assetid: e2a06ee4-b8ee-49c7-935a-c1031a29eef2 -topic_type: - - "apiref" ---- -# ICeeGen::GetSectionDataLen Method - -Gets the length of the specified section. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GetSectionDataLen ( - [in] HCEESECTION section, - [out] ULONG *dataLen -); -``` - -## Parameters - - `section` - [in] The data section whose length will be retrieved. - - `dataLen` - [out] The returned length of the specified section. - -## Remarks - - Call `GetSectionDataLen` only if you have special section requirements that are not handled by other methods. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getstring-method.md b/docs/framework/unmanaged-api/metadata/iceegen-getstring-method.md deleted file mode 100644 index 2640d223f57b2..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-getstring-method.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GetString Method" -title: "ICeeGen::GetString Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GetString" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GetString" -helpviewer_keywords: - - "ICeeGen::GetString method [.NET Framework metadata]" - - "GetString method, ICeeGen interface [.NET Framework metadata]" -ms.assetid: 7cc22562-128c-440a-9147-55ff20f173d7 -topic_type: - - "apiref" ---- -# ICeeGen::GetString Method - -Gets the string stored at the specified relative virtual address. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GetString ( - [in] ULONG RVA, - [out] LPWSTR *lpString -); -``` - -## Parameters - - `RVA` - [in] The relative virtual address of the string to return. - - `lpString` - [out] The returned string. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getstringsection-method.md b/docs/framework/unmanaged-api/metadata/iceegen-getstringsection-method.md deleted file mode 100644 index 31c9493791cf4..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-getstringsection-method.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: "Learn more about: ICeeGen::GetStringSection Method" -title: "ICeeGen::GetStringSection Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.GetStringSection" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::GetStringSection" -helpviewer_keywords: - - "ICeeGen::GetStringSection method [.NET Framework metadata]" - - "GetStringSection method [.NET Framework metadata]" -ms.assetid: a2267d39-69d1-4de1-bf37-f752cafacc71 -topic_type: - - "apiref" ---- -# ICeeGen::GetStringSection Method - -Gets a string representation of the code section referenced by the specified handle. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT GetStringSection ( - [in, out] HCEESECTION *section -); -``` - -## Parameters - - `section` - [in, out] The handle to the code section. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/iceegen-truncatesection-method.md b/docs/framework/unmanaged-api/metadata/iceegen-truncatesection-method.md deleted file mode 100644 index b78fb227397c6..0000000000000 --- a/docs/framework/unmanaged-api/metadata/iceegen-truncatesection-method.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: "Learn more about: ICeeGen::TruncateSection Method" -title: "ICeeGen::TruncateSection Method" -ms.date: "03/30/2017" -api_name: - - "ICeeGen.TruncateSection" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeGen::TruncateSection" -helpviewer_keywords: - - "TruncateSection method [.NET Framework metadata]" - - "ICeeGen::TruncateSection method [.NET Framework metadata]" -ms.assetid: 0451d752-1e5c-4c9a-8bad-6cd35b7ba3df -topic_type: - - "apiref" ---- -# ICeeGen::TruncateSection Method - -Truncates the specified code section by the specified length. - - This method is obsolete and should not be used. - -## Syntax - -```cpp -HRESULT TruncateSection ( - [in] HCEESECTION section, - [in] ULONG len -); -``` - -## Parameters - - `section` - [in] The section to truncate. - - `len` - [in] The length, in bytes, by which to truncate the section. - -## Remarks - - Call `TruncateSection` only if you have special section requirements that are not handled by other methods. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [ICeeGen Interface](iceegen-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/ihostfilter-interface.md b/docs/framework/unmanaged-api/metadata/ihostfilter-interface.md deleted file mode 100644 index b558cd9f51d19..0000000000000 --- a/docs/framework/unmanaged-api/metadata/ihostfilter-interface.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: "Learn more about: IHostFilter Interface" -title: "IHostFilter Interface" -ms.date: "03/30/2017" -api_name: - - "IHostFilter" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IHostFilter" -helpviewer_keywords: - - "IHostFilter interface [.NET Framework metadata]" -ms.assetid: e79456b1-045b-4a84-9714-2ea560ff75ea -topic_type: - - "apiref" ---- -# IHostFilter Interface - -Provides a method to indicate that a specified token will be processed. - -> [!NOTE] -> The `IHostFilter` interface must be implemented by the client. - -## Methods - -|Method|Description| -|------------|-----------------| -|[MarkToken Method](ihostfilter-marktoken-method.md)|Indicates that the specified metadata token will be processed.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/metadata/imaptoken-interface.md b/docs/framework/unmanaged-api/metadata/imaptoken-interface.md deleted file mode 100644 index d2abd681d9655..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imaptoken-interface.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: "Learn more about: IMapToken Interface" -title: "IMapToken Interface" -ms.date: "03/30/2017" -api_name: - - "IMapToken" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMapToken" -helpviewer_keywords: - - "IMapToken interface [.NET Framework metadata]" -ms.assetid: 4c5c4df0-43f3-4830-a01b-8d029806f2c4 -topic_type: - - "apiref" ---- -# IMapToken Interface - -Provides mapping capabilities between assemblies. - -> [!NOTE] -> The `IMapToken` interface must be implemented by the client. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Map Method](imaptoken-map-method.md)|Maps a relationship between two assemblies using metadata signatures.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md b/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md deleted file mode 100644 index 9900e2721522a..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -description: "Learn more about: IMetaDataAssemblyEmit::DefineAssembly Method" -title: "IMetaDataAssemblyEmit::DefineAssembly Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataAssemblyEmit.DefineAssembly" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataAssemblyEmit::DefineAssembly" -helpviewer_keywords: - - "IMetaDataAssemblyEmit::DefineAssembly method [.NET Framework metadata]" - - "DefineAssembly method [.NET Framework metadata]" -ms.assetid: a0637d66-74bf-4f2d-8137-9ff838bccece -topic_type: - - "apiref" ---- -# IMetaDataAssemblyEmit::DefineAssembly Method - -Creates an `Assembly` structure containing metadata for the specified assembly and returns the associated metadata token. - -## Syntax - -```cpp -HRESULT DefineAssembly ( - [in] void *pbPublicKey, - [in] ULONG cbPublicKey, - [in] ULONG uHashAlgId, - [in] LPCWSTR szName, - [in] ASSEMBLYMETADATA *pMetaData, - [in] DWORD dwAssemblyFlags, - [out] mdAssembly *pmda -); -``` - -## Parameters - - `pbPublicKey` - [in] The public key that identifies the publisher of the assembly, or NULL if the assembly is not strongly named. - - `cbPublicKey` - [in] The size in bytes of `pbPublicKey`. - - `uHashAlgId` - [in] The identifier of the hashing algorithm to use to encrypt the files in the assembly, or NULL to specify the SHA-1 algorithm. - - `szName` - [in] The human-readable text name of the assembly. This value must not exceed 1024 characters. - - `pMetaData` - [in] A pointer to an [ASSEMBLYMETADATA](assemblymetadata-structure.md) instance that contains the version, platform, and locale information for the assembly. - - `dwAssemblyFlags` - [in] A combination of [CorAssemblyFlags](corassemblyflags-enumeration.md) values that describe features of the assembly. - - `pmda` - [out] A pointer to the metadata token. - -## Remarks - - Only one `Assembly` metadata structure can be defined within a manifest. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md b/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md deleted file mode 100644 index e1eefebe40c34..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -description: "Learn more about: IMetaDataAssemblyEmit::DefineAssemblyRef Method" -title: "IMetaDataAssemblyEmit::DefineAssemblyRef Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataAssemblyEmit.DefineAssemblyRef" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataAssemblyEmit::DefineAssemblyRef" -helpviewer_keywords: - - "DefineAssemblyRef method [.NET Framework metadata]" - - "IMetaDataAssemblyEmit::DefineAssemblyRef method [.NET Framework metadata]" -ms.assetid: 0b284b18-0084-4b3a-912a-5ebe9f29c88b -topic_type: - - "apiref" ---- -# IMetaDataAssemblyEmit::DefineAssemblyRef Method - -Creates an `AssemblyRef` structure containing metadata for the assembly that this assembly references, and returns the associated metadata token. - -## Syntax - -```cpp -HRESULT DefineAssemblyRef ( - [in] void *pbPublicKeyOrToken, - [in] ULONG cbPublicKeyOrToken, - [in] LPCWSTR szName, - [in] ASSEMBLYMETADATA pMetaData, - [in] void *pbHashValue, - [in] ULONG cbHashValue, - [in] DWORD dwAssemblyRefFlags, - [out] mdAssemblyRef *pmdar -); -``` - -## Parameters - - `pbPublicKeyOrToken` - [in] The public key of the publisher of the referenced assembly. The helper function [StrongNameTokenFromAssembly](../strong-naming/strongnametokenfromassembly-function.md) can be used to get the hash of the public key to pass as this parameter. - - `cbPublicKeyOrToken` - [in] The size in bytes of `pbPublicKeyOrToken`. - - `szName` - [in] The human-readable text name of the assembly. This value must not exceed 1024 characters. - - `pMetaData` - [in] An ASSEMBLYMETADATA instance that contains the version, platform and locale information of the referenced assembly. - - `pbHashValue` - [in] The hash data associated with the referenced assembly. Optional. - - `cbHashValue` - [in] The size in bytes of `pbHashValue`. - - `dwAssemblyRefFlags` - [in] A bitwise combination of [CorAssemblyFlags](corassemblyflags-enumeration.md) values that influence the behavior of the execution engine. - - `pmdar` - [out] A pointer to the returned `AssemblyRef` metadata token. - -## Remarks - - One `AssemblyRef` metadata structure must be defined for each assembly that this assembly references. - - At run time, the details of a referenced assembly are passed to the assembly resolver with an indication that they represent the "as built" information. The assembly resolver then applies policy. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md b/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md deleted file mode 100644 index f2f52e7028b5b..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: "Learn more about: IMetaDataAssemblyEmit::DefineFile Method" -title: "IMetaDataAssemblyEmit::DefineFile Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataAssemblyEmit.DefineFile" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataAssemblyEmit::DefineFile" -helpviewer_keywords: - - "IMetaDataAssemblyEmit::DefineFile method [.NET Framework metadata]" - - "DefineFile method [.NET Framework metadata]" -ms.assetid: c065aadf-c1ca-4981-bde6-597042cb29c4 -topic_type: - - "apiref" ---- -# IMetaDataAssemblyEmit::DefineFile Method - -Creates a `File` metadata structure containing metadata for assembly referenced by this assembly, and returns the associated metadata token. - -## Syntax - -```cpp -HRESULT DefineFile ( - [in] LPCWSTR szName, - [in] const void *pbHashValue, - [in] ULONG cbHashValue, - [in] DWORD dwFileFlags, - [out] mdFile *pmdf -); -``` - -## Parameters - - `szName` - [in] The name of the file to be consumed. - - `pbHashValue` - [in] A pointer to the hash data associated with the assembly. - - `cbHashValue` - [in] The size in bytes of `pbHashValue`. - - `dwFileFlags` - [in] A bitwise combination of `FileFlags` values that specify property settings. - - `pmdf` - [out] A pointer to the returned `File` token. - -## Remarks - - One `File` metadata structure must be defined for each file that was part of this assembly at the time that this assembly was built, excluding the file that contains the metadata. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md deleted file mode 100644 index 51690ba20c352..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -description: "Learn more about: IMetaDataAssemblyEmit::SetAssemblyProps Method" -title: "IMetaDataAssemblyEmit::SetAssemblyProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataAssemblyEmit.SetAssemblyProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataAssemblyEmit::SetAssemblyProps" -helpviewer_keywords: - - "SetAssemblyProps method [.NET Framework metadata]" - - "IMetaDataAssemblyEmit::SetAssemblyProps method [.NET Framework metadata]" -ms.assetid: 91b633d7-9e75-43c3-a8d2-2144984e5f9e -topic_type: - - "apiref" ---- -# IMetaDataAssemblyEmit::SetAssemblyProps Method - -Modifies the specified `Assembly` metadata structure. - -## Syntax - -```cpp -HRESULT SetAssemblyProps ( - [in] mdAssembly pma, - [in] const void *pbPublicKey, - [in] ULONG cbPublicKey, - [in] ULONG ulHashAlgId, - [in] LPCWSTR szName, - [in] const ASSEMBLYMETADATA *pMetaData, - [in] DWORD dwAssemblyFlags -); -``` - -## Parameters - - `pma` - [in] The metadata token that specifies the `Assembly` metadata structure to be modified. - - `pbPublicKey` - [in] A pointer to the public key of the publisher of the assembly. - - `cbPublicKey` - [in] The size in bytes of `pbPublicKey`. - - `ulHashAlgId` - [in] The identifier for the hash algorithm used to hash the assembly files. - - `szName` - [in] The human-readable text name of the assembly. - - `pMetaData` - [in] A pointer to the ASSEMBLYMETADATA that contains version, platform, and locale information for the assembly. - - `dwAssemblyFlags` - [in] A bitwise combination of [AssemblyFlags](assemblyflags-enumeration.md) values that specify various attributes of the assembly. - -## Remarks - - To create an `Assembly` metadata structure, use the [IMetaDataAssemblyEmit::DefineAssembly](imetadataassemblyemit-defineassembly-method.md) method. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md deleted file mode 100644 index ec2cbb7606ceb..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -description: "Learn more about: IMetaDataAssemblyEmit::SetAssemblyRefProps Method" -title: "IMetaDataAssemblyEmit::SetAssemblyRefProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataAssemblyEmit.SetAssemblyRefProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataAssemblyEmit::SetAssemblyRefProps" -helpviewer_keywords: - - "SetAssemblyRefProps method [.NET Framework metadata]" - - "IMetaDataAssemblyEmit::SetAssemblyRefProps method [.NET Framework metadata]" -ms.assetid: 70a32bf3-9051-4f96-ae87-11356d06a073 -topic_type: - - "apiref" ---- -# IMetaDataAssemblyEmit::SetAssemblyRefProps Method - -Modifies the specified `AssemblyRef` metadata structure. - -## Syntax - -```cpp -HRESULT SetAssemblyRefProps ( - [in] mdAssemblyRef ar, - [in] const void *pbPublicKeyOrToken, - [in] ULONG cbPublicKeyOrToken, - [in] LPCWSTR szName, - [in] const ASSEMBLYMETADATA *pMetaData, - [in] const void *pbHashValue, - [in] ULONG cbHashValue, - [in] DWORD dwAssemblyRefFlags -); -``` - -## Parameters - - `ar` - [in] The metadata token that specifies the `AssemblyRef` metadata structure to be modified. - - `pbPublicKeyOrToken` - [in] The public key of the publisher of the referenced assembly. - - `cbPublicKeyOrToken` - [in] The size in bytes of `pbPublicKeyOrToken`. - - `szName` - [in] The human-readable text name of the assembly. - - `pMetaData` - [in] A pointer to an ASSEMBLYMETADATA instance that contains the version, platform, and locale information for the assembly. - - `pbHashValue` - [in] A pointer to the hash data associated with the assembly. - - `cbHashValue` - [in] The size in bytes of `pbHashValue`. - - `dwAssemblyRefFlags` - [in] A bitwise combination of [AssemblyRefFlags](assemblyrefflags-enumeration.md) values that specify attributes of the referenced assembly. - -## Remarks - - To create an `AssemblyRef` metadata structure, use the [IMetaDataAssemblyEmit::DefineAssemblyRef](imetadataassemblyemit-defineassemblyref-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md deleted file mode 100644 index b045cc5a8454c..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: "Learn more about: IMetaDataAssemblyEmit::SetExportedTypeProps Method" -title: "IMetaDataAssemblyEmit::SetExportedTypeProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataAssemblyEmit.SetExportedTypeProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataAssemblyEmit::SetExportedTypeProps" -helpviewer_keywords: - - "SetExportedTypeProps method [.NET Framework metadata]" - - "IMetaDataAssemblyEmit::SetExportedTypeProps method [.NET Framework metadata]" -ms.assetid: 1c090153-fd5f-46c7-9cff-39a78d992c8f -topic_type: - - "apiref" ---- -# IMetaDataAssemblyEmit::SetExportedTypeProps Method - -Modifies the specified `ExportedType` metadata structure. - -## Syntax - -```cpp -HRESULT SetExportedTypeProps ( - [in] mdExportedType ct, - [in] mdToken tkImplementation, - [in] mdTypeDef tkTypeDef, - [in] DWORD dwExportedTypeFlags -); -``` - -## Parameters - - `ct` - [in] The metadata token that specifies the `ExportedType` metadata structure to be modified. - - `tkImplementation` - [in] The token, of type `File`, `AssemblyRef`, or `ExportedType`, that specifies how this type is implemented. - - `tkTypeDef` - [in] The `TypeDef` token referenced in the code file. - - `dwExportedTypeFlags` - [in] A bitwise combination of values that specify attributes of the type. - -## Remarks - - To create an `ExportedType` metadata structure, use the [IMetaDataAssemblyEmit::DefineExportedType](imetadataassemblyemit-defineexportedtype-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md deleted file mode 100644 index f41162aa2258b..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: "Learn more about: IMetaDataAssemblyEmit::SetFileProps Method" -title: "IMetaDataAssemblyEmit::SetFileProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataAssemblyEmit.SetFileProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataAssemblyEmit::SetFileProps" -helpviewer_keywords: - - "IMetaDataAssemblyEmit::SetFileProps method [.NET Framework metadata]" - - "SetFileProps method [.NET Framework metadata]" -ms.assetid: 85667d38-611c-45a9-938d-930ac7a7b681 -topic_type: - - "apiref" ---- -# IMetaDataAssemblyEmit::SetFileProps Method - -Modifies the specified `File` metadata structure. - -## Syntax - -```cpp -HRESULT SetFileProps ( - [in] mdFile file, - [in] const void *pbHashValue, - [in] ULONG cbHashValue, - [in] DWORD dwFileFlags -); -``` - -## Parameters - - `file` - [in] The metadata token that specifies the `File` metadata structure to be modified. - - `pbHashValue` - [in] A pointer to the hash data associated with the file. - - `cbHashValue` - [in] The size in bytes of `pbHashValue`. - - `dwFileFlags` - [in] A bitwise combination of [CorFileFlags](corfileflags-enumeration.md) values that specify various attributes of the file. - -## Remarks - - To create a `File` metadata structure, use the [IMetaDataAssemblyEmit::DefineFile](imetadataassemblyemit-definefile-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataAssemblyEmit Interface](imetadataassemblyemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md b/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md deleted file mode 100644 index 4a523c523f6b2..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: "Learn more about: IMetaDataAssemblyImport::CloseEnum Method" -title: "IMetaDataAssemblyImport::CloseEnum Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataAssemblyImport.CloseEnum" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataAssemblyImport::CloseEnum" -helpviewer_keywords: - - "CloseEnum method, IMetaDataAssemblyImport interface [.NET Framework metadata]" - - "IMetaDataAssemblyImport::CloseEnum method [.NET Framework metadata]" -ms.assetid: c9df4087-12b3-46d9-b075-9067dd7805df -topic_type: - - "apiref" ---- -# IMetaDataAssemblyImport::CloseEnum Method - -Releases a reference to the specified enumeration instance. - -## Syntax - -```cpp -void CloseEnum ( - [in] HCORENUM hEnum -); -``` - -## Parameters - - `hEnum` - [in] The enumeration instance to be closed. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md deleted file mode 100644 index 6da1e034be8a9..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -description: "Learn more about: IMetaDataAssemblyImport::GetAssemblyProps Method" -title: "IMetaDataAssemblyImport::GetAssemblyProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataAssemblyImport.GetAssemblyProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataAssemblyImport::GetAssemblyProps" -helpviewer_keywords: - - "GetAssemblyProps method [.NET Framework metadata]" - - "IMetaDataAssemblyImport::GetAssemblyProps method [.NET Framework metadata]" -ms.assetid: 0eaa4aa9-9441-444a-920c-e4b2a2db899e -topic_type: - - "apiref" ---- -# IMetaDataAssemblyImport::GetAssemblyProps Method - -Gets the set of properties for the assembly with the specified metadata signature. - -## Syntax - -```cpp -HRESULT GetAssemblyProps ( - [in] mdAssembly mda, - [out] const void **ppbPublicKey, - [out] ULONG *pcbPublicKey, - [out] ULONG *pulHashAlgId, - [out] LPWSTR szName, - [in] ULONG cchName, - [out] ULONG *pchName, - [out] ASSEMBLYMETADATA *pMetaData, - [out] DWORD *pdwAssemblyFlags -); -``` - -## Parameters - - `mda` - [in]. The `mdAssembly` metadata token that represents the assembly for which to get the properties. - - `ppbPublicKey` - [out] A pointer to the public key or the metadata token. - - `pcbPublicKey` - [out] The number of bytes in the returned public key. - - `pulHashAlgId` - [out] A pointer to the algorithm used to hash the files in the assembly. - - `szName` - [out] The simple name of the assembly. - - `cchName` - [in] The size, in wide chars, of `szName`. - - `pchName` - [out] The number of wide chars actually returned in `szName`. - - `pMetaData` - [out] A pointer to an ASSEMBLYMETADATA structure that contains the assembly metadata. - - `pdwAssemblyFlags` - [out] Flags that describe the metadata applied to an assembly. This value is a combination of one or more [CorAssemblyFlags](corassemblyflags-enumeration.md) values. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataAssemblyImport Interface](imetadataassemblyimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md b/docs/framework/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md deleted file mode 100644 index 53d7c77291763..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn more about: IMetaDataConverter::GetTypeLibFromMetaData Method" -title: "IMetaDataConverter::GetTypeLibFromMetaData Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataConverter.GetTypeLibFromMetaData" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataConverter::GetTypeLibFromMetaData" -helpviewer_keywords: - - "GetTypeLibFromMetaData method [.NET Framework metadata]" - - "IMetaDataConverter::GetTypeLibFromMetaData method [.NET Framework metadata]" -ms.assetid: 90eab7b3-1fae-4af4-8bce-f7bc0e188a99 -topic_type: - - "apiref" ---- -# IMetaDataConverter::GetTypeLibFromMetaData Method - -Gets a pointer to an `ITypeLib` instance that represents the type library that has the specified library and module names. - -## Syntax - -```cpp -HRESULT GetTypeLibFromMetaData ( - [in] BSTR strModule, - [in] BSTR strTlbName, - [out] ITypeLib **ppITL -); -``` - -## Parameters - - `strModule` - [in] The name of the type library's module. - - `strTlbName` - [in] The name of the type library. - - `ppITL` - [out] A pointer to a location that receives the address of the `ITypeLib` instance that represents the type library. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataConverter Interface](imetadataconverter-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md b/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md deleted file mode 100644 index e9fb8dea7f6d0..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -description: "Learn more about: IMetaDataDispenserEx::FindAssembly Method" -title: "IMetaDataDispenserEx::FindAssembly Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataDispenserEx.FindAssembly" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataDispenserEx::FindAssembly" -helpviewer_keywords: - - "FindAssembly method [.NET Framework metadata]" - - "IMetaDataDispenserEx::FindAssembly method [.NET Framework metadata]" -ms.assetid: 3afe7252-5f28-48d9-a74d-1927566c404c -topic_type: - - "apiref" ---- -# IMetaDataDispenserEx::FindAssembly Method - -This method is not implemented. If called, it returns E_NOTIMPL. - -## Syntax - -```cpp -HRESULT FindAssembly( - [in] LPCWSTR szAppBase, - [in] LPCWSTR szPrivateBin, - [in] LPCWSTR szGlobalBin, - [in] LPCWSTR szAssemblyName, - [out] LPCWSTR szName, - [in] ULONG cchName, - [out] ULONG *pcName -); -``` - -## Parameters - - `szAppBase` - [in] Not used. - - `szPrivateBin` - [in] Not used. - - `szGlobalBin` - [in] Not used. - - `szAssemblyName` - [in] The assembly to be found. - - `szName` - [out] The simple name of the assembly. - - `cchName` - [in] The size, in bytes, of `szName`. - - `pcName` - [out] The number of characters actually returned in `szName`. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) -- [IMetaDataDispenser Interface](imetadatadispenser-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md b/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md deleted file mode 100644 index c51b6f432d2ca..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -description: "Learn more about: IMetaDataDispenserEx::FindAssemblyModule Method" -title: "IMetaDataDispenserEx::FindAssemblyModule Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataDispenserEx.FindAssemblyModule" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataDispenserEx::FindAssemblyModule" -helpviewer_keywords: - - "FindAssemblyModule method [.NET Framework metadata]" - - "IMetaDataDispenserEx::FindAssemblyModule method [.NET Framework metadata]" -ms.assetid: d1fb65e1-7e19-4513-85b1-44f87c294d3e -topic_type: - - "apiref" ---- -# IMetaDataDispenserEx::FindAssemblyModule Method - -This method is not implemented. If called, it returns E_NOTIMPL. - -## Syntax - -```cpp -HRESULT FindAssemblyModule( - [in] LPCWSTR szAppBase, - [in] LPCWSTR szPrivateBin, - [in] LPCWSTR szGlobalBin, - [in] LPCWSTR szAssemblyName, - [in] LPCWSTR szModuleName, - [out] LPCWSTR szName, - [in] ULONG cchName, - [out] ULONG *pcName -); -``` - -## Parameters - - `szAppBase` - [in] Not used. - - `szPrivateBin` - [in] Not used. - - `szGlobalBin` - [in] Not used. - - `szAssemblyName` - [in] The name of the module. - - `szModuleName` - [in] The assembly to be found. - - `szName` - [out] The simple name of the assembly. - - `cchName` - [in] The size, in bytes, of `szName`. - - `pcName` - [out] The number of characters actually returned in `szName`. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) -- [IMetaDataDispenser Interface](imetadatadispenser-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md b/docs/framework/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md deleted file mode 100644 index b5136503e5b45..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: "Learn more about: IMetaDataDispenserEx::OpenScopeOnITypeInfo Method" -title: "IMetaDataDispenserEx::OpenScopeOnITypeInfo Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataDispenserEx.OpenScopeOnITypeInfo" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataDispenserEx::OpenScopeOnITypeInfo" -helpviewer_keywords: - - "OpenScopeOnITypeInfo method [.NET Framework metadata]" - - "IMetaDataDispenserEx::OpenScopeOnITypeInfo method [.NET Framework metadata]" -ms.assetid: 3480bbdb-c442-44a0-b7c6-333354503c52 -topic_type: - - "apiref" ---- -# IMetaDataDispenserEx::OpenScopeOnITypeInfo Method - -This method is not implemented. If called, it returns E_NOTIMPL. - -## Syntax - -```cpp -HRESULT OpenScopeOnITypeInfo ( - [in] ITypeInfo *pITI, - [in] DWORD dwOpenFlags, - [in] REFIID riid, - [out] IUnknown **ppIUnk -); -``` - -## Parameters - - `pITI` - [in] Pointer to an [ITypeInfo](/previous-versions/windows/desktop/api/oaidl/nn-oaidl-itypeinfo) interface that provides the type information on which to open the scope. - - `dwOpenFlags` - [in] The open mode flags. - - `riid` - [in] The desired interface. - - `ppIUnk` - [out] Pointer to a pointer to the returned interface. - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataDispenserEx Interface](imetadatadispenserex-interface.md) -- [IMetaDataDispenser Interface](imetadatadispenser-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-defineevent-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit-defineevent-method.md deleted file mode 100644 index 69073ec070572..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-defineevent-method.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit::DefineEvent Method" -title: "IMetaDataEmit::DefineEvent Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit.DefineEvent" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit::DefineEvent" -helpviewer_keywords: - - "IMetaDataEmit::DefineEvent method [.NET Framework metadata]" - - "DefineEvent method [.NET Framework metadata]" -ms.assetid: cf064bac-9a9f-41c5-9e1d-108ff7af3afe -topic_type: - - "apiref" ---- -# IMetaDataEmit::DefineEvent Method - -Creates a definition for an event with the specified metadata signature, and gets a token to that event definition. - -## Syntax - -```cpp -HRESULT DefineEvent ( - [in] mdTypeDef td, - [in] LPCWSTR szEvent, - [in] DWORD dwEventFlags, - [in] mdToken tkEventType, - [in] mdMethodDef mdAddOn, - [in] mdMethodDef mdRemoveOn, - [in] mdMethodDef mdFire, - [in] mdMethodDef rmdOtherMethods[], - [out] mdEvent *pmdEvent -); -``` - -## Parameters - - `td` - [in] The token for the target class or interface. This is either a `mdTypeDef` or `mdTypeDefNil` token. - - `szEvent` - [in] The name of the event. - - `dwEventFlags` - [in] Event flags. - - `tkEventType` - [in] The token for the event class. This is a `mdTypeDef`, a `mdTypeRef`, or a `mdTokenNil` token. - - `mdAddOn` - [in] The method used to subscribe to the event, or null. - - `mdRemoveOn` - [in] The method used to unsubscribe to the event, or null. - - `mdFire` - [in] The method used (by a derived class) to raise the event. - - `rmdOtherMethods[]` - [in] An array of tokens for other methods associated with the event. The array is terminated with a `mdMethodDefNil` token. - - `pmdEvent` - [out] The metadata token assigned to the event. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataEmit Interface](imetadataemit-interface.md) -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md deleted file mode 100644 index 18e7ff53f07fd..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit::DefineUserString Method" -title: "IMetaDataEmit::DefineUserString Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit.DefineUserString" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit::DefineUserString" -helpviewer_keywords: - - "DefineUserString method [.NET Framework metadata]" - - "IMetaDataEmit::DefineUserString method [.NET Framework metadata]" -ms.assetid: 88fb7ef3-bbdf-429c-b678-c9c153456461 -topic_type: - - "apiref" ---- -# IMetaDataEmit::DefineUserString Method - -Gets a metadata token for the specified literal string. - -## Syntax - -```cpp -HRESULT DefineUserString ( - [in] LPCWSTR szString, - [in] ULONG cchString, - [out] mdString *pstk -); -``` - -## Parameters - - `szString` - [in] The user string to store. - - `cchString` - [in] The count of wide characters in `szString`. - - `pstk` - [out] The string token assigned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataEmit Interface](imetadataemit-interface.md) -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-deletetoken-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit-deletetoken-method.md deleted file mode 100644 index 2852b032bdb5d..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-deletetoken-method.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit::DeleteToken Method" -title: "IMetaDataEmit::DeleteToken Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit.DeleteToken" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit::DeleteToken" -helpviewer_keywords: - - "DeleteToken method [.NET Framework metadata]" - - "IMetaDataEmit::DeleteToken method [.NET Framework metadata]" -ms.assetid: a4926d0a-261b-46b1-9994-82633661a64b -topic_type: - - "apiref" ---- -# IMetaDataEmit::DeleteToken Method - -Deletes the specified token from the current metadata scope. - -## Syntax - -```cpp -HRESULT DeleteToken ( - [in] mdToken tkObj -); -``` - -## Parameters - - `tkObj` - [in] The token to be deleted. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataEmit Interface](imetadataemit-interface.md) -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md deleted file mode 100644 index 123bf707991fd..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit::GetTokenFromSig Method" -title: "IMetaDataEmit::GetTokenFromSig Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit.GetTokenFromSig" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit::GetTokenFromSig" -helpviewer_keywords: - - "IMetaDataEmit::GetTokenFromSig method [.NET Framework metadata]" - - "GetTokenFromSig method [.NET Framework metadata]" -ms.assetid: 50a58a83-6287-40a4-b315-47823cea0a5c -topic_type: - - "apiref" ---- -# IMetaDataEmit::GetTokenFromSig Method - -Gets a token for the specified metadata signature. - -## Syntax - -```cpp -HRESULT GetTokenFromSig ( - [in] PCCOR_SIGNATURE pvSig, - [in] ULONG cbSig, - [out] mdSignature *pmsig -); -``` - -## Parameters - - `pvSig` - [in] The signature to be persisted and stored. - - `cbSig` - [in] The count of bytes in `pvSig`. - - `pmsig` - [out] The `mdSignature` token assigned. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataEmit Interface](imetadataemit-interface.md) -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-savetostream-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit-savetostream-method.md deleted file mode 100644 index d85c5bf3b0469..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-savetostream-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit::SaveToStream Method" -title: "IMetaDataEmit::SaveToStream Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit.SaveToStream" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit::SaveToStream" -helpviewer_keywords: - - "IMetaDataEmit::SaveToStream method [.NET Framework metadata]" - - "SaveToStream method [.NET Framework metadata]" -ms.assetid: e0290a49-3818-4a43-ad46-3014faa34f97 -topic_type: - - "apiref" ---- -# IMetaDataEmit::SaveToStream Method - -Saves all metadata in the current scope to the specified `IStream`. - -## Syntax - -```cpp -HRESULT SaveToStream ( - [in] IStream *pIStream, - [in] DWORD dwSaveFlags -); -``` - -## Parameters - - `pIStream` - [in] The writable stream to save to. - - `dwSaveFlags` - [in] Reserved. Must be zero. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataEmit Interface](imetadataemit-interface.md) -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md deleted file mode 100644 index c4e025e282a70..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit::SetMethodProps Method" -title: "IMetaDataEmit::SetMethodProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit.SetMethodProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit::SetMethodProps" -helpviewer_keywords: - - "SetMethodProps method [.NET Framework metadata]" - - "IMetaDataEmit::SetMethodProps method [.NET Framework metadata]" -ms.assetid: e0c6ac12-22ea-43f5-b799-8cda0faf3336 -topic_type: - - "apiref" ---- -# IMetaDataEmit::SetMethodProps Method - -Sets or updates the feature, stored at the specified relative virtual address, of a method defined by a prior call to [IMetaDataEmit::DefineMethod](imetadataemit-definemethod-method.md). - -## Syntax - -```cpp -HRESULT SetMethodProps ( - [in] mdMethodDef md, - [in] DWORD dwMethodFlags, - [in] ULONG ulCodeRVA, - [in] DWORD dwImplFlags -); -``` - -## Parameters - - `md` - [in] The token for the method to be changed. - - `dwMethodFlags` - [in] The member attributes. - - `ulCodeRVA` - [in] The address of the code. - - `dwImplFlags` - [in] The implementation flags for the method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataEmit Interface](imetadataemit-interface.md) -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setparamprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit-setparamprops-method.md deleted file mode 100644 index 2c36fc862c252..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setparamprops-method.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit::SetParamProps Method" -title: "IMetaDataEmit::SetParamProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit.SetParamProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit::SetParamProps" -helpviewer_keywords: - - "IMetaDataEmit::SetParamProps method [.NET Framework metadata]" - - "SetParamProps method [.NET Framework metadata]" -ms.assetid: a95a3908-9f87-4084-937e-8e01ef03ad63 -topic_type: - - "apiref" ---- -# IMetaDataEmit::SetParamProps Method - -Sets or changes features of a method parameter that was defined by a prior call to [IMetaDataEmit::DefineParam](imetadataemit-defineparam-method.md). - -## Syntax - -```cpp -HRESULT SetParamProps ( - [in] mdParamDef pd, - [in] LPCWSTR szName, - [in] DWORD dwParamFlags, - [in] DWORD dwCPlusTypeFlag, - [in] void const *pValue, - [in] ULONG cchValue -); -``` - -## Parameters - - `pd` - [in] The token for the target parameter. - - `szName` - [in] The name of the parameter in Unicode. - - `dwParamFlags` - [in] The flags for the parameter. - - `dwCPlusTypeFlag` - [in] The ELEMENT_TYPE_* for the constant value. - - `pValue` - [in] The constant value for the parameter. - - `cchValue` - [in] The size in (Unicode) characters of `pValue`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataEmit Interface](imetadataemit-interface.md) -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setrva-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit-setrva-method.md deleted file mode 100644 index 5d95d5202f24f..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit-setrva-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit::SetRVA Method" -title: "IMetaDataEmit::SetRVA Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit.SetRVA" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit::SetRVA" -helpviewer_keywords: - - "IMetaDataEmit::SetRVA method [.NET Framework metadata]" - - "SetRVA method [.NET Framework metadata]" -ms.assetid: 4d69fb6d-ee35-4318-8224-5eea2bd16818 -topic_type: - - "apiref" ---- -# IMetaDataEmit::SetRVA Method - -Sets the relative virtual address of the specified method. - -## Syntax - -```cpp -HRESULT SetRVA ( - [in] mdMethodDef md, - [in] ULONG ulRVA -); -``` - -## Parameters - - `md` - [in] The token for the target method or method implementation. - - `ulRVA` - [in] The address of the code or data area. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataEmit Interface](imetadataemit-interface.md) -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md deleted file mode 100644 index f1505f1fa17dd..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit2::GetDeltaSaveSize Method" -title: "IMetaDataEmit2::GetDeltaSaveSize Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit2.GetDeltaSaveSize" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit2::GetDeltaSaveSize" -helpviewer_keywords: - - "IMetaDataEmit2::GetDeltaSaveSize method [.NET Framework metadata]" - - "GetDeltaSaveSize method [.NET Framework metadata]" -ms.assetid: 036db5e7-8211-4645-9a34-03d1a89be955 -topic_type: - - "apiref" ---- -# IMetaDataEmit2::GetDeltaSaveSize Method - -Gets a value indicating any change in metadata size that results from the current edit-and-continue session. - -## Syntax - -```cpp -HRESULT GetDeltaSaveSize ( - [in] CorSaveSize fSave, - [out] DWORD *pdwSaveSize -); -``` - -## Parameters - - `fSave` - [in] One of the [CorSaveSize](corsavesize-enumeration.md) values, indicating the level of precision desired. For .NET Framework version 2.0, this parameter is ignored. - - `pdwSaveSize` - [out] The change in the size of the metadata. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) -- [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md deleted file mode 100644 index ae25f6899956a..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit2::ResetENCLog Method" -title: "IMetaDataEmit2::ResetENCLog Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit2.ResetENCLog" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit2::ResetENCLog" -helpviewer_keywords: - - "ResetENCLog method [.NET Framework metadata]" - - "IMetaDataEmit2::ResetENCLog method [.NET Framework metadata]" -ms.assetid: 44b9fd76-a022-4e9a-aea3-dec5411a9c22 -topic_type: - - "apiref" ---- -# IMetaDataEmit2::ResetENCLog Method - -Resets the edit-and-continue log and starts a new session. - -## Syntax - -```cpp -HRESULT ResetENCLog (); -``` - -## Parameters - - `ResetENCLog` takes no parameters. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) -- [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-savedelta-method.md b/docs/framework/unmanaged-api/metadata/imetadataemit2-savedelta-method.md deleted file mode 100644 index fb24a998e3213..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataemit2-savedelta-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataEmit2::SaveDelta Method" -title: "IMetaDataEmit2::SaveDelta Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataEmit2.SaveDelta" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataEmit2::SaveDelta" -helpviewer_keywords: - - "IMetaDataEmit2::SaveDelta method [.NET Framework metadata]" - - "SaveDelta method [.NET Framework metadata]" -ms.assetid: b95739fe-d2fa-4776-ae0d-31d9707ef799 -topic_type: - - "apiref" ---- -# IMetaDataEmit2::SaveDelta Method - -Saves changes from the current edit-and-continue session to the specified file. - -## Syntax - -```cpp -HRESULT SaveDelta ( - [in] LPCWSTR szFile, - [in] DWORD dwSaveFlags -); -``` - -## Parameters - - `szFile` - [in] The file name under which to save changes. - - `dwSaveFlags` - [in] Reserved. Must be zero. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataEmit2 Interface](imetadataemit2-interface.md) -- [IMetaDataEmit Interface](imetadataemit-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataerror-interface.md b/docs/framework/unmanaged-api/metadata/imetadataerror-interface.md deleted file mode 100644 index f59e99b74b541..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataerror-interface.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: "Learn more about: IMetaDataError Interface" -title: "IMetaDataError Interface" -ms.date: "03/30/2017" -api_name: - - "IMetaDataError" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataError" -helpviewer_keywords: - - "IMetaDataError interface [.NET Framework metadata]" -ms.assetid: 0020b62c-ea88-40c7-a9ee-16b064f81624 -topic_type: - - "apiref" ---- -# IMetaDataError Interface - -Provides a callback mechanism for reporting errors during the metadata merge. - -> [!NOTE] -> The `IMetaDataError` interface must be implemented by the client. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnError Method](imetadataerror-onerror-method.md)|Provides notification of errors that occur during the metadata merge.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataerror-onerror-method.md b/docs/framework/unmanaged-api/metadata/imetadataerror-onerror-method.md deleted file mode 100644 index f997b97ba5093..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataerror-onerror-method.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: "Learn more about: IMetaDataError::OnError Method" -title: "IMetaDataError::OnError Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataError.OnError" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataError::OnError" -helpviewer_keywords: - - "IMetaDataError::OnError method [.NET Framework metadata]" - - "OnError method, IMetaDataError interface [.NET Framework metadata]" -ms.assetid: c1e744b8-a6fb-4d9c-a971-8babc875d8f0 -topic_type: - - "apiref" ---- -# IMetaDataError::OnError Method - -Provides notification of errors that occur during the metadata merge. - -## Syntax - -```cpp -HRESULT OnError ( - [in] HRESULT hrError, - [in] mdToken token -); -``` - -## Parameters - - `hrError` - [in] The HRESULT error value returned to the calling method. - - `token` - [in] The metadata token of the code object that was being merged when the error occurred. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataError Interface](imetadataerror-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md b/docs/framework/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md deleted file mode 100644 index 6b3660669a071..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: "Learn more about: IMetaDataFilter::IsTokenMarked Method" -title: "IMetaDataFilter::IsTokenMarked Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataFilter.IsTokenMarked" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataFilter::IsTokenMarked" -helpviewer_keywords: - - "IMetaDataFilter::IsTokenMarked method [.NET Framework metadata]" - - "IsTokenMarked method [.NET Framework metadata]" -ms.assetid: 7d90dcee-0206-4540-807b-06982fe65f1a -topic_type: - - "apiref" ---- -# IMetaDataFilter::IsTokenMarked Method - -Gets a value indicating whether the specified metadata token has been marked as processed. - -## Syntax - -```cpp -HRESULT IsTokenMarked ( - [in] mdToken tk, - [out] BOOL *pIsMarked -); -``` - -## Parameters - - `tk` - [in] The token to examine for a processing mark. - - `pIsMarked` - [out] A value that is `true` if `tk` has been processed; otherwise `false`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataFilter Interface](imetadatafilter-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatafilter-marktoken-method.md b/docs/framework/unmanaged-api/metadata/imetadatafilter-marktoken-method.md deleted file mode 100644 index 42fa27eb4fd81..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatafilter-marktoken-method.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: "Learn more about: IMetaDataFilter::MarkToken Method" -title: "IMetaDataFilter::MarkToken Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataFilter.MarkToken" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataFilter::MarkToken" -helpviewer_keywords: - - "IMetaDataFilter::MarkToken method [.NET Framework metadata]" - - "MarkToken method, IMetaDataFilter interface [.NET Framework metadata]" -ms.assetid: bd492834-6529-4d39-b93d-f8cdbd3e297f -topic_type: - - "apiref" ---- -# IMetaDataFilter::MarkToken Method - -Sets a value indicating that the specified metadata token has been processed. - -## Syntax - -```cpp -HRESULT MarkToken ( - [in] mdToken tk -); -``` - -## Parameters - - `tk` - [in] The token to mark as processed. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataFilter Interface](imetadatafilter-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md b/docs/framework/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md deleted file mode 100644 index 9e6c007a752cd..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: "Learn more about: IMetaDataFilter::UnmarkAll Method" -title: "IMetaDataFilter::UnmarkAll Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataFilter.UnmarkAll" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataFilter::UnmarkAll" -helpviewer_keywords: - - "IMetaDataFilter::UnmarkAll method [.NET Framework metadata]" - - "UnmarkAll method [.NET Framework metadata]" -ms.assetid: a04d91dc-690f-4de8-8c97-55c69a8503b4 -topic_type: - - "apiref" ---- -# IMetaDataFilter::UnmarkAll Method - -Removes the processing marks from all the tokens in the current metadata scope. - -## Syntax - -```cpp -HRESULT UnmarkAll (); -``` - -## Parameters - - `UnmarkAll` takes no parameters. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataFilter Interface](imetadatafilter-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md deleted file mode 100644 index ad61449d61659..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumCustomAttributes Method" -title: "IMetaDataImport::EnumCustomAttributes Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumCustomAttributes" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumCustomAttributes" -helpviewer_keywords: - - "EnumCustomAttributes method [.NET Framework metadata]" - - "IMetaDataImport::EnumCustomAttributes method [.NET Framework metadata]" -ms.assetid: 798513a0-68b1-4d04-bc5b-782a4445ea68 -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumCustomAttributes Method - -Enumerates custom attribute-definition tokens associated with the specified type or member. - -## Syntax - -```cpp -HRESULT EnumCustomAttributes ( - [in, out] HCORENUM *phEnum, - [in] mdToken tk, - [in] mdToken tkType, - [out] mdCustomAttribute rCustomAttributes[], - [in] ULONG cMax, - [out, optional] ULONG *pcCustomAttributes -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the returned enumerator. - - `tk` - [in] A token for the scope of the enumeration, or zero for all custom attributes. - - `tkType` - [in] A token for the constructor of the type of the attributes to be enumerated, or `null` for all types. - - `rCustomAttributes` - [out] An array of custom attribute tokens. - - `cMax` - [in] The maximum size of the `rCustomAttributes` array. - - `pcCustomAttributes` - [out, optional] The actual number of token values returned in `rCustomAttributes`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumCustomAttributes` returned successfully.| -|`S_FALSE`|There are no custom attributes to enumerate. In that case, `pcCustomAttributes` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumevents-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumevents-method.md deleted file mode 100644 index a3b338e35bf1c..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumevents-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumEvents Method" -title: "IMetaDataImport::EnumEvents Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumEvents" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumEvents" -helpviewer_keywords: - - "IMetaDataImport::EnumEvents method [.NET Framework metadata]" - - "EnumEvents method [.NET Framework metadata]" -ms.assetid: e1efedcb-3dd7-42ae-a399-21c24728aec5 -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumEvents Method - -Enumerates event definition tokens for the specified TypeDef token. - -## Syntax - -```cpp -HRESULT EnumEvents ( - [in, out] HCORENUM *phEnum, - [in] mdTypeDef td, - [out] mdEvent rEvents[], - [in] ULONG cMax, - [out] ULONG *pcEvents -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. - - `td` - [in] The TypeDef token whose event definitions are to be enumerated. - - `rEvents` - [out] The array of returned events. - - `cMax` - [in] The maximum size of the `rEvents` array. - - `pcEvents` - [out] The actual number of events returned in `rEvents`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumEvents` returned successfully.| -|`S_FALSE`|There are no events to enumerate. In that case, `pcEvents` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md deleted file mode 100644 index fb27d94737e9b..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumMemberRefs Method" -title: "IMetaDataImport::EnumMemberRefs Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumMemberRefs" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumMemberRefs" -helpviewer_keywords: - - "EnumMemberRefs method [.NET Framework metadata]" - - "IMetaDataImport::EnumMemberRefs method [.NET Framework metadata]" -ms.assetid: e97c97a6-6e4f-41f5-9af1-9b3cf3bdbd6b -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumMemberRefs Method - -Enumerates MemberRef tokens representing members of the specified type. - -## Syntax - -```cpp -HRESULT EnumMemberRefs ( - [in, out] HCORENUM *phEnum, - [in] mdToken tkParent, - [out] mdMemberRef rMemberRefs[], - [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. - - `tkParent` - [in] A TypeDef, TypeRef, MethodDef, or ModuleRef token for the type whose members are to be enumerated. - - `rMemberRefs` - [out] The array used to store MemberRef tokens. - - `cMax` - [in] The maximum size of the `rMemberRefs` array. - - `pcTokens` - [out] The actual number of MemberRef tokens returned in `rMemberRefs`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumMemberRefs` returned successfully.| -|`S_FALSE`|There are no MemberRef tokens to enumerate. In that case, `pcTokens` is to zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethods-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enummethods-method.md deleted file mode 100644 index c438bdcdb5ee0..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethods-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumMethods Method" -title: "IMetaDataImport::EnumMethods Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumMethods" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumMethods" -helpviewer_keywords: - - "IMetaDataImport::EnumMethods method [.NET Framework metadata]" - - "EnumMethods method [.NET Framework metadata]" -ms.assetid: 8cc3b0c3-d97d-4f71-9e7d-ef2a92b4959a -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumMethods Method - -Enumerates MethodDef tokens representing methods of the specified type. - -## Syntax - -```cpp -HRESULT EnumMethods ( - [in, out] HCORENUM *phEnum, - [in] mdTypeDef cl, - [out] mdMethodDef rMethods[], - [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `cl` - [in] A TypeDef token representing the type with the methods to enumerate. - - `rMethods` - [out] The array to store the MethodDef tokens. - - `cMax` - [in] The maximum size of the MethodDef `rMethods` array. - - `pcTokens` - [out] The number of MethodDef tokens returned in `rMethods`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumMethods` returned successfully.| -|`S_FALSE`|There are no MethodDef tokens to enumerate. In that case, `pcTokens` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md deleted file mode 100644 index 0ef59aa363c55..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumMethodsWithName Method" -title: "IMetaDataImport::EnumMethodsWithName Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumMethodsWithName" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumMethodsWithName" -helpviewer_keywords: - - "IMetaDataImport::EnumMethodsWithName method [.NET Framework metadata]" - - "EnumMethodsWithName method [.NET Framework metadata]" -ms.assetid: a8624913-2e23-46ad-a0c1-bb8eccbbf20f -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumMethodsWithName Method - -Enumerates methods that have the specified name and that are defined by the type referenced by the specified TypeDef token. - -## Syntax - -```cpp -HRESULT EnumMethodsWithName ( - [in, out] HCORENUM *phEnum, - [in] mdTypeDef cl, - [in] LPCWSTR szName, - [out] mdMethodDef rMethods[], - [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `cl` - [in] A TypeDef token representing the type whose methods to enumerate. - - `szName` - [in] The name that limits the scope of the enumeration. - - `rMethods` - [out] The array used to store the MethodDef tokens. - - `cMax` - [in] The maximum size of the `rMethods` array. - - `pcTokens` - [out] The number of MethodDef tokens returned in `rMethods`. - -## Remarks - - This method enumerates fields and methods, but not properties or events. Unlike [IMetaDataImport::EnumMethods](imetadataimport-enummethods-method.md), `EnumMethodsWithName` discards all method tokens that do not have the specified name. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumMethodsWithName` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTokens` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md deleted file mode 100644 index 9662ecbeef21c..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumModuleRefs Method" -title: "IMetaDataImport::EnumModuleRefs Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumModuleRefs" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumModuleRefs" -helpviewer_keywords: - - "EnumModuleRefs method [.NET Framework metadata]" - - "IMetaDataImport::EnumModuleRefs method [.NET Framework metadata]" -ms.assetid: 53441f3a-68d2-477c-906e-37c55dfcfb4d -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumModuleRefs Method - -Enumerates ModuleRef tokens that represent imported modules. - -## Syntax - -```cpp -HRESULT EnumModuleRefs ( - [in, out] HCORENUM *phEnum, - [out] mdModuleRef rModuleRefs[], - [in] ULONG cMax, - [out] ULONG *pcModuleRefs -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `rModuleRefs` - [out] The array used to store the ModuleRef tokens. - - `cMax` - [in] The maximum size of the `rModuleRefs` array. - - `pcModuleRefs` - [out] The number of ModuleRef tokens returned in `rModuleRefs`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumModuleRefs` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcModuleRefs` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumparams-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumparams-method.md deleted file mode 100644 index 86e59f1ddad50..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumparams-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumParams Method" -title: "IMetaDataImport::EnumParams Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumParams" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumParams" -helpviewer_keywords: - - "IMetaDataImport::EnumParams method [.NET Framework metadata]" - - "EnumParams method [.NET Framework metadata]" -ms.assetid: 52118dc9-fe6e-4b39-aa48-c3cc3ea4214d -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumParams Method - -Enumerates ParamDef tokens representing the parameters of the method referenced by the specified MethodDef token. - -## Syntax - -```cpp -HRESULT EnumParams ( - [in, out] HCORENUM *phEnum, - [in] mdMethodDef mb, - [out] mdParamDef rParams[], - [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `mb` - [in] A MethodDef token representing the method with the parameters to enumerate. - - `rParams` - [out] The array used to store the ParamDef tokens. - - `cMax` - [in] The maximum size of the `rParams` array. - - `pcTokens` - [out] The number of ParamDef tokens returned in `rParams`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumParams` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTokens` is zero.| - -## Requirements - - **Platform:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md deleted file mode 100644 index 14b67b814ef17..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumPermissionSets Method" -title: "IMetaDataImport::EnumPermissionSets Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumPermissionSets" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumPermissionSets" -helpviewer_keywords: - - "EnumPermissionSets method [.NET Framework metadata]" - - "IMetaDataImport::EnumPermissionSets method [.NET Framework metadata]" -ms.assetid: 347d7e5c-c90f-45ad-bd1e-2c7912b0b19c -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumPermissionSets Method - -Enumerates permissions for the objects in a specified metadata scope. - -## Syntax - -```cpp -HRESULT EnumPermissionSets - [in, out] HCORENUM *phEnum, - [in] mdToken tk, - [in] DWORD dwActions, - [out] mdPermission rPermission[], - [in] ULONG cMax, - [out] ULONG *pcTokens -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `tk` - [in] A metadata token that limits the scope of the search, or NULL to search the widest scope possible. - - `dwActions` - [in] Flags representing the values to include in `rPermission`, or zero to return all actions. - - `rPermission` - [out] The array used to store the Permission tokens. - - `cMax` - [in] The maximum size of the `rPermission` array. - - `pcTokens` - [out] The number of Permission tokens returned in `rPermission`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumPermissionSets` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTokens` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumproperties-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumproperties-method.md deleted file mode 100644 index 54050e2ecfc21..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumproperties-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumProperties Method" -title: "IMetaDataImport::EnumProperties Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumProperties" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumProperties" -helpviewer_keywords: - - "IMetaDataImport::EnumProperties method [.NET Framework metadata]" - - "EnumProperties method [.NET Framework metadata]" -ms.assetid: 60573ad7-8821-4721-a068-3f7a6d25926a -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumProperties Method - -Enumerates PropertyDef tokens representing the properties of the type referenced by the specified TypeDef token. - -## Syntax - -```cpp -HRESULT EnumProperties ( - [in, out] HCORENUM *phEnum, - [in] mdTypeDef td, - [out] mdProperty rProperties[], - [in] ULONG cMax, - [out] ULONG *pcProperties -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `td` - [in] A TypeDef token representing the type with properties to enumerate. - - `rProperties` - [out] The array used to store the PropertyDef tokens. - - `cMax` - [in] The maximum size of the `rProperties` array. - - `pcProperties` - [out] The number of PropertyDef tokens returned in `rProperties`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumProperties` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcProperties` is zero.| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md deleted file mode 100644 index ccd9a8954896f..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumSignatures Method" -title: "IMetaDataImport::EnumSignatures Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumSignatures" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumSignatures" -helpviewer_keywords: - - "EnumSignatures method [.NET Framework metadata]" - - "IMetaDataImport::EnumSignatures method [.NET Framework metadata]" -ms.assetid: d0d65060-6f90-42a2-95cf-6ffb04352996 -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumSignatures Method - -Enumerates Signature tokens representing stand-alone signatures in the current scope. - -## Syntax - -```cpp -HRESULT EnumSignatures ( - [in, out] HCORENUM *phEnum, - [out] mdSignature rSignatures[], - [in] ULONG cMax, - [out] ULONG *pcSignatures -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `rSignatures` - [out] The array used to store the Signature tokens. - - `cMax` - [in] The maximum size of the `rSignatures` array. - - `pcSignatures` - [out] The number of Signature tokens returned in `rSignatures`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumSignatures` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcSignatures` is zero.| - -## Remarks - - The Signature tokens are created by the [IMetaDataEmit::GetTokenFromSig](imetadataemit-gettokenfromsig-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md deleted file mode 100644 index e4367a035d7a1..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumTypeDefs Method" -title: "IMetaDataImport::EnumTypeDefs Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumTypeDefs" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumTypeDefs" -helpviewer_keywords: - - "EnumTypeDefs method [.NET Framework metadata]" - - "IMetaDataImport::EnumTypeDefs method [.NET Framework metadata]" -ms.assetid: 4e508711-da92-4381-aaf8-6803075cdaa2 -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumTypeDefs Method - -Enumerates TypeDef tokens representing all types within the current scope. - -## Syntax - -```cpp -HRESULT EnumTypeDefs ( - [out] HCORENUM *phEnum, - [in] mdTypeDef rTypeDefs[], - [in] ULONG cMax, - [out] ULONG *pcTypeDefs -); -``` - -## Parameters - - `phEnum` - [out] A pointer to the new enumerator. This must be NULL for the first call of this method. - - `rTypeDefs` - [in] The array used to store the TypeDef tokens. - - `cMax` - [in] The maximum size of the `rTypeDefs` array. - - `pcTypeDefs` - [out] The number of TypeDef tokens returned in `rTypeDefs`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumTypeDefs` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTypeDefs` is zero.| - -## Remarks - - The TypeDef token represents a type such as a class or an interface, as well as any type added via an extensibility mechanism. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md deleted file mode 100644 index 92747572be996..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumTypeRefs Method" -title: "IMetaDataImport::EnumTypeRefs Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumTypeRefs" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumTypeRefs" -helpviewer_keywords: - - "EnumTypeRefs method [.NET Framework metadata]" - - "IMetaDataImport::EnumTypeRefs method [.NET Framework metadata]" -ms.assetid: b4896b8f-8e97-469c-8089-e72a025661b5 -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumTypeRefs Method - -Enumerates TypeRef tokens defined in the current metadata scope. - -## Syntax - -```cpp -HRESULT EnumTypeRefs ( - [in, out] HCORENUM *phEnum, - [out] mdTypeRef rTypeRefs[], - [in] ULONG cMax, - [out] ULONG *pcTypeRefs -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `rTypeRefs` - [out] The array used to store the TypeRef tokens. - - `cMax` - [in] The maximum size of the `rTypeRefs` array. - - `pcTypeRefs` - [out] A pointer to the number of TypeRef tokens returned in `rTypeRefs`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumTypeRefs` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTypeRefs` is zero.| - -## Remarks - - A TypeRef token represents a reference to a type. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md deleted file mode 100644 index 48016dfa633ac..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumTypeSpecs Method" -title: "IMetaDataImport::EnumTypeSpecs Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumTypeSpecs" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumTypeSpecs" -helpviewer_keywords: - - "EnumTypeSpecs method [.NET Framework metadata]" - - "IMetaDataImport::EnumTypeSpecs method [.NET Framework metadata]" -ms.assetid: 75331c7b-988b-436c-9eb9-a270d37b4f06 -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumTypeSpecs Method - -Enumerates TypeSpec tokens defined in the current metadata scope. - -## Syntax - -```cpp -HRESULT EnumTypeSpecs ( - [in, out] HCORENUM *phEnum, - [out] mdTypeSpec rTypeSpecs[], - [in] ULONG cMax, - [out] ULONG *pcTypeSpecs -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This value must be NULL for the first call of this method. - - `rTypeSpecs` - [out] The array used to store the TypeSpec tokens. - - `cMax` - [in] The maximum size of the `rTypeSpecs` array. - - `pcTypeSpecs` - [out] The number of TypeSpec tokens returned in `rTypeSpecs`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumTypeSpecs` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcTypeSpecs` is zero.| - -## Remarks - - The TypeSpec tokens are created by the [IMetaDataEmit::GetTokenFromTypeSpec](imetadataemit-gettokenfromtypespec-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md deleted file mode 100644 index 09e45d6121a21..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::EnumUserStrings Method" -title: "IMetaDataImport::EnumUserStrings Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.EnumUserStrings" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::EnumUserStrings" -helpviewer_keywords: - - "IMetaDataImport::EnumUserStrings method [.NET Framework metadata]" - - "EnumUserStrings method [.NET Framework metadata]" -ms.assetid: 2b1f1418-4be8-4cdb-b418-b3abccc527a7 -topic_type: - - "apiref" ---- -# IMetaDataImport::EnumUserStrings Method - -Enumerates String tokens representing hard-coded strings in the current metadata scope. - -## Syntax - -```cpp -HRESULT EnumUserStrings ( - [in, out] HCORENUM *phEnum, - [out] mdString rStrings[], - [in] ULONG cMax, - [out] ULONG *pcStrings -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. This must be NULL for the first call of this method. - - `rStrings` - [out] The array used to store the String tokens. - - `cMax` - [in] The maximum size of the `rStrings` array. - - `pcStrings` - [out] The number of String tokens returned in `rStrings`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumUserStrings` returned successfully.| -|`S_FALSE`|There are no tokens to enumerate. In that case, `pcStrings` is zero.| - -## Remarks - - The String tokens are created by the [IMetaDataEmit::DefineUserString](imetadataemit-defineuserstring-method.md) method. This method is designed to be used by a metadata browser rather than by a compiler. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md deleted file mode 100644 index 6d43b11f36c9c..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::FindTypeDefByName Method" -title: "IMetaDataImport::FindTypeDefByName Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.FindTypeDefByName" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::FindTypeDefByName" -helpviewer_keywords: - - "FindTypeDefByName method [.NET Framework metadata]" - - "IMetaDataImport::FindTypeDefByName method [.NET Framework metadata]" -ms.assetid: f4c2cd88-ac28-4bad-9ab1-2cf9d2de41e6 -topic_type: - - "apiref" ---- -# IMetaDataImport::FindTypeDefByName Method - -Gets a pointer to the TypeDef metadata token for the with the specified name. - -## Syntax - -```cpp -HRESULT FindTypeDefByName - [in] LPCWSTR szTypeDef, - [in] mdToken tkEnclosingClass, - [out] mdTypeDef *ptd -); -``` - -## Parameters - - `szTypeDef` - [in] The name of the type for which to get the TypeDef token. - - `tkEnclosingClass` - [in] A TypeDef or TypeRef token representing the enclosing class. If the type to find is not a nested class, set this value to NULL. - - `ptd` - [out] A pointer to the matching TypeDef token. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-findtyperef-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-findtyperef-method.md deleted file mode 100644 index d3c3cc1a4341d..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-findtyperef-method.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::FindTypeRef Method" -title: "IMetaDataImport::FindTypeRef Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.FindTypeRef" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::FindTypeRef" -helpviewer_keywords: - - "IMetaDataImport::FindTypeRef method [.NET Framework metadata]" - - "FindTypeRef method [.NET Framework metadata]" -ms.assetid: 1b2bbf3f-943e-412e-b66c-e802431b055c -topic_type: - - "apiref" ---- -# IMetaDataImport::FindTypeRef Method - -Gets a pointer to the TypeRef token for the reference that is in the specified scope and that has the specified name. - -## Syntax - -```cpp -HRESULT FindTypeRef ( - [in] mdToken tkResolutionScope, - [in] LPCWSTR szName, - [out] mdTypeRef *ptr -); -``` - -## Parameters - - `tkResolutionScope` - [in] A ModuleRef, AssemblyRef, or TypeRef token that specifies the module, assembly, or type, respectively, in which the type reference is defined. - - `szName` - [in] The name of the type reference to search for. - - `ptr` - [out] A pointer to the matching TypeRef token. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md deleted file mode 100644 index 07bcb580318fe..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetClassLayout Method" -title: "IMetaDataImport::GetClassLayout Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetClassLayout" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetClassLayout" -helpviewer_keywords: - - "IMetaDataImport::GetClassLayout method [.NET Framework metadata]" - - "GetClassLayout method, IMetaDataImport interface [.NET Framework metadata]" -ms.assetid: 8f35414d-f40b-4b99-8768-9adb675c622a -topic_type: - - "apiref" ---- -# IMetaDataImport::GetClassLayout Method - -Gets layout information for the class referenced by the specified TypeDef token. - -## Syntax - -```cpp -HRESULT GetClassLayout ( - [in] mdTypeDef td, - [out] DWORD *pdwPackSize, - [out] COR_FIELD_OFFSET rFieldOffset[], - [in] ULONG cMax, - [out] ULONG *pcFieldOffset, - [out] ULONG *pulClassSize -); -``` - -## Parameters - - `td` - [in] The TypeDef token for the class with the layout to return. - - `pdwPackSize` - [out] One of the values 1, 2, 4, 8, or 16, representing the pack size of the class. - - `rFieldOffset` - [out] An array of [COR_FIELD_OFFSET](cor-field-offset-structure.md) values. - - `cMax` - [in] The maximum size of the `rFieldOffset` array. - - `pcFieldOffset` - [out] The number of elements returned in `rFieldOffset`. - - `pulClassSize` - [out] The size in bytes of the class represented by `td`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md deleted file mode 100644 index 51309a94e7315..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetFieldProps Method" -title: "IMetaDataImport::GetFieldProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetFieldProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetFieldProps" -helpviewer_keywords: - - "IMetaDataImport::GetFieldProps method [.NET Framework metadata]" - - "GetFieldProps method [.NET Framework metadata]" -ms.assetid: 7b0e9b10-8cef-4ba6-8432-40bf63e65ab1 -topic_type: - - "apiref" ---- -# IMetaDataImport::GetFieldProps Method - -Gets metadata associated with the field referenced by the specified FieldDef token. - -## Syntax - -```cpp -HRESULT GetFieldProps ( - [in] mdFieldDef mb, - [out] mdTypeDef *pClass, - [out] LPWSTR szField, - [in] ULONG cchField, - [out] ULONG *pchField, - [out] DWORD *pdwAttr, - [out] PCCOR_SIGNATURE *ppvSigBlob, - [out] ULONG *pcbSigBlob, - [out] DWORD *pdwCPlusTypeFlag, - [out] UVCP_CONSTANT *ppValue, - [out] ULONG *pcchValue -); -``` - -## Parameters - - `mb` - [in] A FieldDef token that represents the field to get associated metadata for. - - `pClass` - [out] A pointer to a TypeDef token that represents the type of the class that the field belongs to. - - `szField` - [out] The name of the field. - - `cchField` - [in] The size in wide characters of the buffer for *szField*. - - `pchField` - [out] The actual size of the returned buffer. - - `pdwAttr` - [out] Flags associated with the field's metadata. - - `ppvSigBlob` - [out] A pointer to the binary metadata value that describes the field. - - `pcbSigBlob` - [out] The size in bytes of `ppvSigBlob`. - - `pdwCPlusTypeFlag` - [out] A flag that specifies the value type of the field. - - `ppValue` - [out] A constant value for the field. - - `pcchValue` - [out] The size in chars of `ppValue`, or zero if no string exists. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md deleted file mode 100644 index 97ef619fdd786..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetMethodProps Method" -title: "IMetaDataImport::GetMethodProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetMethodProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetMethodProps" -helpviewer_keywords: - - "GetMethodProps method [.NET Framework metadata]" - - "IMetaDataImport::GetMethodProps method [.NET Framework metadata]" -ms.assetid: e0667ef7-1d31-4c89-a2d3-d426f023f8d2 -topic_type: - - "apiref" ---- -# IMetaDataImport::GetMethodProps Method - -Gets the metadata associated with the method referenced by the specified MethodDef token. - -## Syntax - -```cpp -HRESULT GetMethodProps ( - [in] mdMethodDef mb, - [out] mdTypeDef *pClass, - [out] LPWSTR szMethod, - [in] ULONG cchMethod, - [out] ULONG *pchMethod, - [out] DWORD *pdwAttr, - [out] PCCOR_SIGNATURE *ppvSigBlob, - [out] ULONG *pcbSigBlob, - [out] ULONG *pulCodeRVA, - [out] DWORD *pdwImplFlags -); -``` - -## Parameters - - `mb` - [in] The MethodDef token that represents the method to return metadata for. - - `pClass` - [out] A Pointer to a TypeDef token that represents the type that implements the method. - - `szMethod` - [out] A Pointer to a buffer that has the method's name. - - `cchMethod` - [in] The requested size of `szMethod`. - - `pchMethod` - [out] A Pointer to the size in wide characters of `szMethod`, or in the case of truncation, the actual number of wide characters in the method name. - - `pdwAttr` - [out] A pointer to any flags associated with the method. - - `ppvSigBlob` - [out] A pointer to the binary metadata signature of the method. - - `pcbSigBlob` - [out] A Pointer to the size in bytes of `ppvSigBlob`. - - `pulCodeRVA` - [out] A pointer to the relative virtual address of the method. - - `pdwImplFlags` - [out] A pointer to any implementation flags for the method. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md deleted file mode 100644 index 56d8df53dcf93..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetNativeCallConvFromSig Method" -title: "IMetaDataImport::GetNativeCallConvFromSig Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetNativeCallConvFromSig" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetNativeCallConvFromSig" -helpviewer_keywords: - - "GetNativeCallConvFromSig method [.NET Framework metadata]" - - "IMetaDataImport::GetNativeCallConvFromSig method [.NET Framework metadata]" -ms.assetid: 50e04026-4d4a-47d9-96c1-f4677d6d938b -topic_type: - - "apiref" ---- -# IMetaDataImport::GetNativeCallConvFromSig Method - -Gets the native calling convention for the method that is represented by the specified signature pointer. - -## Syntax - -```cpp -HRESULT GetNativeCallConvFromSig ( - [in] void const *pvSig, - [in] ULONG cbSig, - [out] ULONG *pCallConv -); -``` - -## Parameters - - `pvSig` - [in] A pointer to the metadata signature of the method to return the calling convention for. - - `cbSig` - [in] The size in bytes of `pvSig`. - - `pCallConv` - [out] A pointer to the native calling convention. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getparamprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-getparamprops-method.md deleted file mode 100644 index b7148d6115581..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getparamprops-method.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetParamProps Method" -title: "IMetaDataImport::GetParamProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetParamProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetParamProps" -helpviewer_keywords: - - "IMetaDataImport::GetParamProps method [.NET Framework metadata]" - - "GetParamProps method [.NET Framework metadata]" -ms.assetid: 4d5e5f00-bcab-4f41-b191-176511a186a7 -topic_type: - - "apiref" ---- -# IMetaDataImport::GetParamProps Method - -Gets metadata values for the parameter referenced by the specified ParamDef token. - -## Syntax - -```cpp -HRESULT GetParamProps ( - [in] mdParamDef tk, - [out] mdMethodDef *pmd, - [out] ULONG *pulSequence, - [out] LPWSTR szName, - [in] ULONG cchName, - [out] ULONG *pchName, - [out] DWORD *pdwAttr, - [out] DWORD *pdwCPlusTypeFlag, - [out] UVCP_CONSTANT *ppValue, - [out] ULONG *pcchValue -); -``` - -## Parameters - - `tk` - [in] A ParamDef token that represents the parameter to return metadata for. - - `pmd` - [out] A pointer to a MethodDef token representing the method that takes the parameter. - - `pulSequence` - [out] The ordinal position of the parameter in the method argument list. - - `szName` - [out] A buffer to hold the name of the parameter. - - `cchName` - [in] The requested size in wide characters of `szName`. - - `pchName` - [out] The returned size in wide characters of `szName`. - - `pdwAttr` - [out] A pointer to any attribute flags associated with the parameter. This is a bitmask of `CorParamAttr` values. - - `pdwCPlusTypeFlag` - [out] A pointer to a flag specifying that the parameter is a . - - `ppValue` - [out] A pointer to a constant string returned by the parameter. - - `pcchValue` - [out] The size of `ppValue` in wide characters, or zero if `ppValue` does not hold a string. - -## Remarks - -The sequence values in `pulSequence` begin with 1 for parameters. A return value has a sequence number of 0. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md deleted file mode 100644 index 04a6031bc66b4..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetPinvokeMap Method" -title: "IMetaDataImport::GetPinvokeMap Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetPinvokeMap" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetPinvokeMap" -helpviewer_keywords: - - "IMetaDataImport::GetPinvokeMap method [.NET Framework metadata]" - - "GetPinvokeMap method [.NET Framework metadata]" -ms.assetid: b8685c1e-b80c-4198-8eb3-748d6f48a99e -topic_type: - - "apiref" ---- -# IMetaDataImport::GetPinvokeMap Method - -Gets a ModuleRef token to represent the target assembly of a PInvoke call. - -## Syntax - -```cpp -HRESULT GetPinvokeMap ( - [in] mdToken tk, - [out] DWORD *pdwMappingFlags, - [out] LPWSTR szImportName, - [in] ULONG cchImportName, - [out] ULONG *pchImportName, - [out] mdModuleRef *pmrImportDLL -); -``` - -## Parameters - - `tk` - [in] A FieldDef or MethodDef token to get the PInvoke mapping metadata for. - - `pdwMappingFlags` - [out] A pointer to flags used for mapping. This value is a bitmask from the [CorPinvokeMap](corpinvokemap-enumeration.md) enumeration. - - `szImportName` - [out] The name of the unmanaged target DLL. - - `cchImportName` - [in] The size in wide characters of `szImportName`. - - `pchImportName` - [out] The number of wide characters returned in `szImportName`. - - `pmrImportDLL` - [out] A pointer to a ModuleRef token that represents the unmanaged target object library. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md deleted file mode 100644 index afd191319d72b..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetScopeProps Method" -title: "IMetaDataImport::GetScopeProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetScopeProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetScopeProps" -helpviewer_keywords: - - "IMetaDataImport::GetScopeProps method [.NET Framework metadata]" - - "GetScopeProps method [.NET Framework metadata]" -ms.assetid: c8ba42d2-d9fa-43cb-bbc0-f33e1e592cb6 -topic_type: - - "apiref" ---- -# IMetaDataImport::GetScopeProps Method - -Gets the name and optionally the version identifier of the assembly or module in the current metadata scope. - -## Syntax - -```cpp -HRESULT GetScopeProps ( - [out] LPWSTR szName, - [in] ULONG cchName, - [out] ULONG *pchName, - [out, optional] GUID *pmvid -); -``` - -## Parameters - - `szName` - [out] A buffer for the assembly or module name. - - `cchName` - [in] The size in wide characters of `szName`. - - `pchName` - [out] The number of wide characters returned in `szName`. - - `pmvid` - [out, optional] A pointer to a GUID that uniquely identifies the version of the assembly or module. - -## Remarks - - The [IMetaDataEmit::SetModuleProps](imetadataemit-setmoduleprops-method.md) method is used to set these properties. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md deleted file mode 100644 index 2de6258251bfb..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetTypeDefProps Method" -title: "IMetaDataImport::GetTypeDefProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetTypeDefProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetTypeDefProps" -helpviewer_keywords: - - "GetTypeDefProps method [.NET Framework metadata]" - - "IMetaDataImport::GetTypeDefProps method [.NET Framework metadata]" -ms.assetid: 00061a25-ba05-47a7-b984-fd916b06b149 -topic_type: - - "apiref" ---- -# IMetaDataImport::GetTypeDefProps Method - -Returns metadata information for the represented by the specified TypeDef token. - -## Syntax - -```cpp -HRESULT GetTypeDefProps ( - [in] mdTypeDef td, - [out] LPWSTR szTypeDef, - [in] ULONG cchTypeDef, - [out] ULONG *pchTypeDef, - [out] DWORD *pdwTypeDefFlags, - [out] mdToken *ptkExtends -); -``` - -## Parameters - - `td` - [in] The TypeDef token that represents the type to return metadata for. - - `szTypeDef` - [out] A buffer containing the type name. - - `cchTypeDef` - [in] The size in wide characters of `szTypeDef`. - - `pchTypeDef` - [out] The number of wide characters returned in `szTypeDef`. - - `pdwTypeDefFlags` - [out] A pointer to any flags that modify the type definition. This value is a bitmask from the [CorTypeAttr](cortypeattr-enumeration.md) enumeration. - - `ptkExtends` - [out] A TypeDef or TypeRef metadata token that represents the base type of the requested type. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md deleted file mode 100644 index 3c1fbd8ccf22c..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetTypeRefProps Method" -title: "IMetaDataImport::GetTypeRefProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetTypeRefProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetTypeRefProps" -helpviewer_keywords: - - "IMetaDataImport::GetTypeRefProps method [.NET Framework metadata]" - - "GetTypeRefProps method [.NET Framework metadata]" -ms.assetid: 01837955-ce1e-4068-b338-fd473bd77d1d -topic_type: - - "apiref" ---- -# IMetaDataImport::GetTypeRefProps Method - -Gets the metadata associated with the referenced by the specified TypeRef token. - -## Syntax - -```cpp -HRESULT GetTypeRefProps ( - [in] mdTypeRef tr, - [out] mdToken *ptkResolutionScope, - [out] LPWSTR szName, - [in] ULONG cchName, - [out] ULONG *pchName -); -``` - -## Parameters - - `tr` - [in] The TypeRef token that represents the type to return metadata for. - - `ptkResolutionScope` - [out] A pointer to the scope in which the reference is made. This value is an AssemblyRef or ModuleRef token. - - `szName` - [out] A buffer containing the type name. - - `cchName` - [in] The requested size in wide characters of `szName`. - - `pchName` - [out] The returned size in wide characters of `szName`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getuserstring-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-getuserstring-method.md deleted file mode 100644 index 18e5f5c4aa46d..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-getuserstring-method.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::GetUserString Method" -title: "IMetaDataImport::GetUserString Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.GetUserString" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::GetUserString" -helpviewer_keywords: - - "IMetaDataImport::GetUserString method [.NET Framework metadata]" - - "GetUserString method, IMetaDataImport interface [.NET Framework metadata]" -ms.assetid: 0fd3bb47-58b5-4083-b241-b9719df7a285 -topic_type: - - "apiref" ---- -# IMetaDataImport::GetUserString Method - -Gets the literal string represented by the specified metadata token. - -## Syntax - -```cpp -HRESULT GetUserString ( - [in] mdString stk, - [out] LPWSTR szString, - [in] ULONG cchString, - [out] ULONG *pchString -); -``` - -## Parameters - - `stk` - [in] The String token to return the associated string for. - - `szString` - [out] A copy of the requested string. - - `cchString` - [in] The maximum size in wide characters of the requested `szString`. - - `pchString` - [out] The size in wide characters of the returned `szString`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-isglobal-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-isglobal-method.md deleted file mode 100644 index 2b5a351284b95..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-isglobal-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::IsGlobal Method" -title: "IMetaDataImport::IsGlobal Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.IsGlobal" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::IsGlobal" -helpviewer_keywords: - - "IsGlobal method [.NET Framework metadata]" - - "IMetaDataImport::IsGlobal method [.NET Framework metadata]" -ms.assetid: 44cf6908-f555-4ae8-b2cf-24bd974bf2fe -topic_type: - - "apiref" ---- -# IMetaDataImport::IsGlobal Method - -Gets a value indicating whether the field, method, or type represented by the specified metadata token has global scope. - -## Syntax - -```cpp -HRESULT IsGlobal ( - [in] mdToken pd, - [out] int *pbGlobal -); -``` - -## Parameters - - `pd` - [in] A metadata token that represents a type, field, or method. - - `pbGlobal` - [out] 1 if the object has global scope; otherwise, 0 (zero). - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md deleted file mode 100644 index e7a3975e57691..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::IsValidToken Method" -title: "IMetaDataImport::IsValidToken Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.IsValidToken" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::IsValidToken" -helpviewer_keywords: - - "IMetaDataImport::IsValidToken method [.NET Framework metadata]" - - "IsValidToken method [.NET Framework metadata]" -ms.assetid: aeb0fc63-9eff-4384-9284-cb9900572d74 -topic_type: - - "apiref" ---- -# IMetaDataImport::IsValidToken Method - -Gets a value indicating whether the specified token holds a valid reference to a code object. - -## Syntax - -```cpp -BOOL IsValidToken ( - [in] mdToken tk -); -``` - -## Parameters - - `tk` - [in] The token to check the reference validity for. - -## Return Value - - `true` if `tk` is a valid metadata token within the current scope. Otherwise, `false`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-resetenum-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport-resetenum-method.md deleted file mode 100644 index 74eeba355725a..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport-resetenum-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport::ResetEnum Method" -title: "IMetaDataImport::ResetEnum Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport.ResetEnum" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport::ResetEnum" -helpviewer_keywords: - - "ResetEnum method [.NET Framework metadata]" - - "IMetaDataImport::ResetEnum method [.NET Framework metadata]" -ms.assetid: dda867b5-1050-49ba-b01c-fcc83b7a5617 -topic_type: - - "apiref" ---- -# IMetaDataImport::ResetEnum Method - -Resets the specified enumerator to the specified position. - -## Syntax - -```cpp -HRESULT ResetEnum ( - [in] HCORENUM hEnum, - [in] ULONG ulPos -); -``` - -## Parameters - - `hEnum` - [in] The enumerator to reset. - - `ulPos` - [in] The new position at which to place the enumerator. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md deleted file mode 100644 index c4c7b45e013d4..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport2::EnumGenericParams Method" -title: "IMetaDataImport2::EnumGenericParams Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport2.EnumGenericParams" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport2::EnumGenericParams" -helpviewer_keywords: - - "EnumGenericParams method [.NET Framework metadata]" - - "IMetaDataImport2::EnumGenericParams method [.NET Framework metadata]" -ms.assetid: b50488a5-3cf0-483c-82dc-2892a3ec61ac -topic_type: - - "apiref" ---- -# IMetaDataImport2::EnumGenericParams Method - -Gets an enumerator for an array of generic parameter tokens associated with the specified TypeDef or MethodDef token. - -## Syntax - -```cpp -HRESULT EnumGenericParams ( - [in, out] HCORENUM *phEnum, - [in] mdToken tk, - [out] mdGenericParam rGenericParams[], - [in] ULONG cMax, - [out] ULONG *pcGenericParams -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator. - - `tk` - [in] The TypeDef or MethodDef token whose generic parameters are to be enumerated. - - `rGenericParams` - [out] The array of generic parameters to enumerate. - - `cMax` - [in] The requested maximum number of tokens to place in `rGenericParams`. - - `pcGenericParams` - [out] The returned number of tokens placed in `rGenericParams`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumGenericParams` returned successfully.| -|`S_FALSE`|`phEnum` has no member elements. In this case, `pcGenericParams` is set to 0 (zero).| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) -- [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md deleted file mode 100644 index aa57c5357c58d..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport2::EnumMethodSpecs Method" -title: "IMetaDataImport2::EnumMethodSpecs Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport2.EnumMethodSpecs" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport2::EnumMethodSpecs" -helpviewer_keywords: - - "IMetaDataImport2::EnumMethodSpecs method [.NET Framework metadata]" - - "EnumMethodSpecs method [.NET Framework metadata]" -ms.assetid: b3fc1e6c-bcb6-4915-baf8-7dc0a31b8724 -topic_type: - - "apiref" ---- -# IMetaDataImport2::EnumMethodSpecs Method - -Gets an enumerator for an array of MethodSpec tokens associated with the specified MethodDef or MemberRef token. - -## Syntax - -```cpp -HRESULT EnumMethodSpecs ( - [in, out] HCORENUM *phEnum, - [in] mdToken tk, - [out] mdMethodSpec rMethodSpecs[], - [in] ULONG cMax, - [out] ULONG *pcMethodSpecs -); -``` - -## Parameters - - `phEnum` - [in, out] A pointer to the enumerator for `rMethodSpecs`. - - `tk` - [in] The MemberRef or MethodDef token that represents the method whose MethodSpec tokens are to be enumerated. If the value of `tk` is 0 (zero), all MethodSpec tokens in the scope will be enumerated. - - `rMethodSpecs` - [out] The array of MethodSpec tokens to enumerate. - - `cMax` - [in] The requested maximum number of tokens to place in `rMethodSpecs`. - - `pcMethodSpecs` - [out] The returned number of tokens placed in `rMethodSpecs`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|`S_OK`|`EnumMethodSpecs` returned successfully.| -|`S_FALSE`|`phEnum` has no member elements. In this case, `pcMethodSpecs` is set to 0 (zero).| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) -- [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md deleted file mode 100644 index 726e52b61fa85..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport2::GetGenericParamProps Method" -title: "IMetaDataImport2::GetGenericParamProps Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport2.GetGenericParamProps" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport2::GetGenericParamProps" -helpviewer_keywords: - - "IMetaDataImport2::GetGenericParamProps method [.NET Framework metadata]" - - "GetGenericParamProps method [.NET Framework metadata]" -ms.assetid: dbb21e67-712b-49e7-a27c-a1e73ffd46c5 -topic_type: - - "apiref" ---- -# IMetaDataImport2::GetGenericParamProps Method - -Gets the metadata associated with the generic parameter represented by the specified token. - -## Syntax - -```cpp -HRESULT GetGenericParamProps ( - [in] mdGenericParam gp, - [out] ULONG *pulParamSeq, - [out] DWORD *pdwParamFlags, - [out] mdToken *ptOwner, - [out] DWORD *reserved, - [out] LPWSTR wzName, - [in] ULONG cchName, - [out] ULONG *pchName -); -``` - -## Parameters - - `gp` - [in] The token that represents the generic parameter for which to return metadata. - - `pulParamSeq` - [out] The ordinal position of the `Type` parameter in the parent constructor or method. - - `pdwParamFlags` - [out] A value of the [CorGenericParamAttr](corgenericparamattr-enumeration.md) enumeration that describes the `Type` for the generic parameter. - - `ptOwner` - [out] A TypeDef or MethodDef token that represents the owner of the parameter. - - `reserved` - [out] Reserved for future extensibility. - - `wzName` - [out] The name of the generic parameter. - - `cchName` - [in] The size of the `wzName` buffer. - - `pchName` - [out] The returned size of the name, in wide characters. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) -- [IMetaDataImport Interface](imetadataimport-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-getpekind-method.md b/docs/framework/unmanaged-api/metadata/imetadataimport2-getpekind-method.md deleted file mode 100644 index b039aac041e06..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadataimport2-getpekind-method.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: "Learn more about: IMetaDataImport2::GetPEKind Method" -title: "IMetaDataImport2::GetPEKind Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataImport2.GetPEKind" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataImport2::GetPEKind" -helpviewer_keywords: - - "GetPEKind method [.NET Framework metadata]" - - "IMetaDataImport2::GetPEKind method [.NET Framework metadata]" -ms.assetid: d91c3d89-8022-4a4c-a2a2-a8af2c387507 -topic_type: - - "apiref" ---- -# IMetaDataImport2::GetPEKind Method - -Gets a value identifying the nature of the code in the portable executable (PE) file, typically a DLL or EXE file, that is defined in the current metadata scope. - -## Syntax - -```cpp -HRESULT GetPEKind ( - [out] DWORD *pdwPEKind, - [out] DWORD *pdwMachine -); -``` - -## Parameters - - `pdwPEKind` - [out] A pointer to a value of the [CorPEKind](corpekind-enumeration.md) enumeration that describes the PE file. - - `pdwMachine` - [out] A pointer to a value that identifies the architecture of the machine. See the next section for possible values. - -## Remarks - - The value referenced by the `pdwMachine` parameter can be one of the following. - -|Value|Machine architecture| -|-----------|--------------------------| -|IMAGE_FILE_MACHINE_I386

0x014C|x86| -|IMAGE_FILE_MACHINE_IA64

0x0200|Intel IPF| -|IMAGE_FILE_MACHINE_AMD64

0x8664|x64| - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataImport2 Interface](imetadataimport2-interface.md) -- [IMetaDataImport Interface](imetadataimport-interface.md) -- [CorPEKind Enumeration](corpekind-enumeration.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getblob-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables-getblob-method.md deleted file mode 100644 index 253bd6d051b66..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getblob-method.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables::GetBlob Method" -title: "IMetaDataTables::GetBlob Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables.GetBlob" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables::GetBlob" -helpviewer_keywords: - - "GetBlob method [.NET Framework metadata]" - - "IMetaDataTables::GetBlob method [.NET Framework metadata]" -ms.assetid: 94667c1c-6d58-4aa7-b74e-530b11e2a276 -topic_type: - - "apiref" ---- -# IMetaDataTables::GetBlob Method - -Gets a pointer to the binary large object (BLOB) at the specified column index. - -## Syntax - -```cpp -HRESULT GetBlob ( - [in] ULONG ixBlob, - [out] ULONG *pcbData, - [out] const void **ppData -); -``` - -## Parameters - - `ixBlob` - [in] The memory address from which to get `ppData`. - - `pcbData` - [out] A pointer to the size, in bytes, of `ppData`. - - `ppData` - [out] A pointer to a pointer to the binary data retrieved. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataTables Interface](imetadatatables-interface.md) -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md deleted file mode 100644 index 70a2439412d6d..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables::GetCodedTokenInfo Method" -title: "IMetaDataTables::GetCodedTokenInfo Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables.GetCodedTokenInfo" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables::GetCodedTokenInfo" -helpviewer_keywords: - - "GetCodedTokenInfo method [.NET Framework metadata]" - - "IMetaDataTables::GetCodedTokenInfo method [.NET Framework metadata]" -ms.assetid: 31214d3a-715e-49af-92b3-0fd11e4f218a -topic_type: - - "apiref" ---- -# IMetaDataTables::GetCodedTokenInfo Method - -Gets a pointer to an array of tokens associated with the specified row index. - -## Syntax - -```cpp -HRESULT GetCodedTokenInfo ( - [in] ULONG ixCdTkn, - [out] ULONG *pcTokens, - [out] ULONG **ppTokens, - [out] const char **ppName -); -``` - -## Parameters - - `ixCdTkn` - [in] The kind of coded token to return. - - `pcTokens` - [out] A pointer to the length of `ppTokens`. - - `ppTokens` - [out] A pointer to a pointer to an array that contains the list of returned tokens. - - `ppName` - [out] A pointer to a pointer to the name of the token at `ixCdTkn`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataTables Interface](imetadatatables-interface.md) -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md deleted file mode 100644 index bd676893c715f..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables::GetGuidHeapSize Method" -title: "IMetaDataTables::GetGuidHeapSize Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables.GetGuidHeapSize" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables::GetGuidHeapSize" -helpviewer_keywords: - - "GetGuidHeapSize method [.NET Framework metadata]" - - "IMetaDataTables::GetGuidHeapSize method [.NET Framework metadata]" -ms.assetid: e875cbee-1ad9-4f1a-bf03-38cdb8ff371a -topic_type: - - "apiref" ---- -# IMetaDataTables::GetGuidHeapSize Method - -Gets the size, in bytes, of the GUID heap. - -## Syntax - -```cpp -HRESULT GetGuidHeapSize ( - [out] ULONG *pcbGuids -); -``` - -## Parameters - - `pcbGuids` - [out] A pointer to the size, in bytes, of the GUID heap. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataTables Interface](imetadatatables-interface.md) -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextblob-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables-getnextblob-method.md deleted file mode 100644 index 60dc3b43114b9..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextblob-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables::GetNextBlob Method" -title: "IMetaDataTables::GetNextBlob Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables.GetNextBlob" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables::GetNextBlob" -helpviewer_keywords: - - "IMetaDataTables::GetNextBlob method [.NET Framework metadata]" - - "GetNextBlob method [.NET Framework metadata]" -ms.assetid: 017c8ab4-4c09-4754-9935-5b0b49cabecb -topic_type: - - "apiref" ---- -# IMetaDataTables::GetNextBlob Method - -Gets the index of the next binary large object (BLOB) in the table. - -## Syntax - -```cpp -HRESULT GetNextBlob ( - [in] ULONG ixBlob, - [out] ULONG *pNext -); -``` - -## Parameters - - `ixBlob` - [in] The index, as returned from a column of BLOBs. - - `pNext` - [out] A pointer to the index of the next BLOB. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataTables Interface](imetadatatables-interface.md) -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextstring-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables-getnextstring-method.md deleted file mode 100644 index 711423b1527e6..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextstring-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables::GetNextString Method" -title: "IMetaDataTables::GetNextString Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables.GetNextString" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables::GetNextString" -helpviewer_keywords: - - "IMetaDataTables::GetNextString method [.NET Framework metadata]" - - "GetNextString method [.NET Framework metadata]" -ms.assetid: d9720428-c353-4f07-a7e8-899e106a1b37 -topic_type: - - "apiref" ---- -# IMetaDataTables::GetNextString Method - -Gets the index of the next string in the current table column. - -## Syntax - -```cpp -HRESULT GetNextString ( - [in] ULONG ixString, - [out] ULONG *pNext -); -``` - -## Parameters - - `ixString` - [in] The index value from a string table column. - - `pNext` - [out] A pointer to the index of the next string in the column. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataTables Interface](imetadatatables-interface.md) -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getstring-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables-getstring-method.md deleted file mode 100644 index 25fe944184bb5..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getstring-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables::GetString Method" -title: "IMetaDataTables::GetString Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables.GetString" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables::GetString" -helpviewer_keywords: - - "IMetaDataTables::GetString method [.NET Framework metadata]" - - "GetString method, IMetaDataTables interface [.NET Framework metadata]" -ms.assetid: 895c35cf-b95d-4e3b-93b5-cfc1cf9044fc -topic_type: - - "apiref" ---- -# IMetaDataTables::GetString Method - -Gets the string at the specified index from the table column in the current reference scope. - -## Syntax - -```cpp -HRESULT GetString ( - [in] ULONG ixString, - [out] const char **ppString -); -``` - -## Parameters - - `ixString` - [in] The index at which to start to search for the next value. - - `ppString` - [out] A pointer to a pointer to the returned string value. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataTables Interface](imetadatatables-interface.md) -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md deleted file mode 100644 index 1e30225c670e0..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables::GetStringHeapSize Method" -title: "IMetaDataTables::GetStringHeapSize Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables.GetStringHeapSize" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables::GetStringHeapSize" -helpviewer_keywords: - - "IMetaDataTables::GetStringHeapSize method [.NET Framework metadata]" - - "GetStringHeapSize method [.NET Framework metadata]" -ms.assetid: ed8f6335-81f5-4c09-81a9-2a909fc530c9 -topic_type: - - "apiref" ---- -# IMetaDataTables::GetStringHeapSize Method - -Gets the size, in bytes, of the string heap. - -## Syntax - -```cpp -HRESULT GetStringHeapSize ( - [out] ULONG *pcbStrings -); -``` - -## Parameters - - `pcbStrings` - [out] A pointer to the size, in bytes, of the string heap. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataTables Interface](imetadatatables-interface.md) -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md deleted file mode 100644 index 1944f8fd39e8a..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables::GetTableInfo Method" -title: "IMetaDataTables::GetTableInfo Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables.GetTableInfo" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables::GetTableInfo" -helpviewer_keywords: - - "IMetaDataTables::GetTableInfo method [.NET Framework metadata]" - - "GetTableInfo method [.NET Framework metadata]" -ms.assetid: 50cbe557-2322-41aa-8e0d-f967602eaa0f -topic_type: - - "apiref" ---- -# IMetaDataTables::GetTableInfo Method - -Gets the name, row size, number of rows, number of columns, and key column index of the specified table. - -## Syntax - -```cpp -HRESULT GetTableInfo ( - [in] ULONG ixTbl, - [out] ULONG *pcbRow, - [out] ULONG *pcRows, - [out] ULONG *pcCols, - [out] ULONG *piKey, - [out] const char **ppName -); -``` - -## Parameters - - `ixTbl` - [in] The identifier of the table whose properties to return. - - `pcbRow` - [out] A pointer to the size, in bytes, of a table row. - - `pcRows` - [out] A pointer to the number of rows in the table. - - `pcCols` - [out] A pointer to the number of columns in the table. - - `piKey` - [out] A pointer to the index of the key column, or -1 if the table has no key column. - - `ppName` - [out] A pointer to a pointer to the table name. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## See also - -- [IMetaDataTables Interface](imetadatatables-interface.md) -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md deleted file mode 100644 index 7a65454655611..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables2::GetMetaDataStorage Method" -title: "IMetaDataTables2::GetMetaDataStorage Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables2.GetMetaDataStorage" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables2::GetMetaDataStorage" -helpviewer_keywords: - - "GetMetaDataStorage method [.NET Framework metadata]" - - "IMetaDataTables2::GetMetaDataStorage method [.NET Framework metadata]" -ms.assetid: 667a6d1e-753d-4ea2-8fd8-a8337d1bb9cd -topic_type: - - "apiref" ---- -# IMetaDataTables2::GetMetaDataStorage Method - -Gets the size and contents of the metadata stored in the specified section. - -## Syntax - -```cpp -HRESULT GetMetaDataStorage ( - [in, out] const void **ppvMd, - [out] ULONG *pcbMd -); -``` - -## Parameters - - `ppvMd` - [in, out] A pointer to a metadata section. - - `pcbMd` - [out] The size of the metadata stream. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) -- [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md b/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md deleted file mode 100644 index 8cb94fcb69046..0000000000000 --- a/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: "Learn more about: IMetaDataTables2::GetMetaDataStreamInfo Method" -title: "IMetaDataTables2::GetMetaDataStreamInfo Method" -ms.date: "03/30/2017" -api_name: - - "IMetaDataTables2.GetMetaDataStreamInfo" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IMetaDataTables2::GetMetaDataStreamInfo" -helpviewer_keywords: - - "GetMetaDataStreamInfo method [.NET Framework metadata]" - - "IMetaDataTables2::GetMetaDataStreamInfo method [.NET Framework metadata]" -ms.assetid: 8b280627-cc74-4789-95da-1fefc966de05 -topic_type: - - "apiref" ---- -# IMetaDataTables2::GetMetaDataStreamInfo Method - -Gets the name, size, and contents of the metadata stream at the specified index. - -## Syntax - -```cpp -HRESULT GetMetaDataStreamInfo ( - [in] ULONG ix, - [out] const char **ppchName, - [out] const void **ppv, - [out] ULONG *pcb -); -``` - -## Parameters - - `ix` - [in] The index of the requested metadata stream. - - `ppchName` - [out] A pointer to the name of the stream. - - `ppv` - [out] A pointer to the metadata stream. - - `pcb` - [out] The size, in bytes, of `ppv`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** Cor.h - - **Library:** Used as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - -## See also - -- [IMetaDataTables2 Interface](imetadatatables2-interface.md) -- [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/framework/unmanaged-api/metadata/index.md b/docs/framework/unmanaged-api/metadata/index.md deleted file mode 100644 index f7d9d1a77a12d..0000000000000 --- a/docs/framework/unmanaged-api/metadata/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -description: "Learn more about: Metadata (Unmanaged API Reference)" -title: "Metadata (Unmanaged API Reference)" -ms.date: "03/30/2017" -helpviewer_keywords: - - "unmanaged API reference [.NET Framework], metadata" - - "native API reference [.NET Framework], metadata" - - "metadata [.NET Framework], using the unmanaged API" -ms.assetid: 10cfea92-db5e-4bcb-b301-ef029bcf77a3 ---- -# Metadata (Unmanaged API Reference) - -The metadata API enables a client, such as a compiler, to generate or access a component's metadata without the types being loaded by the common language runtime (CLR). - -## In This Section - - [Metadata Interfaces](metadata-interfaces.md) - Describes the unmanaged interfaces that provide access to the metadata exposed by the .NET Framework types, methods, fields, and so on. - - [Metadata Global Static Functions](metadata-global-static-functions.md) - Describes the unmanaged global static functions that the metadata API uses. - - [Metadata Enumerations](metadata-enumerations.md) - Describes the unmanaged enumerations that the metadata API uses. - - [Metadata Structures](metadata-structures.md) - Describes the unmanaged structures that the metadata API uses. - - [Metadata Unions](metadata-unions.md) - Describes the unmanaged unions that the metadata API uses. diff --git a/docs/framework/unmanaged-api/metadata/metadata-enumerations.md b/docs/framework/unmanaged-api/metadata/metadata-enumerations.md deleted file mode 100644 index dca6ba24eb7ee..0000000000000 --- a/docs/framework/unmanaged-api/metadata/metadata-enumerations.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -description: "Learn more about: Metadata Enumerations" -title: "Metadata Enumerations" -ms.date: "03/30/2017" -helpviewer_keywords: - - "enumerations [.NET Framework metadata]" - - "metadata enumerations [.NET Framework]" - - "unmanaged enumerations [.NET Framework], metadata" -ms.assetid: 711ab251-cfdb-4280-aaa6-9bc1b341cdc3 ---- -# Metadata Enumerations - -This section describes the unmanaged enumerations that the metadata API uses. - -## In This Section - - [AssemblyFlags Enumeration](assemblyflags-enumeration.md) - Contains values that describe the run-time features of an assembly. - - [AssemblyRefFlags Enumeration](assemblyrefflags-enumeration.md) - Contains values that describe the features of an assembly reference. - - [CeeSectionAttr Enumeration](ceesectionattr-enumeration.md) - Provides values that specify the attributes of a section for use by the [ICeeGen](iceegen-interface.md) interface. - - [CeeSectionRelocType Enumeration](ceesectionreloctype-enumeration.md) - Provides values to influence the type of `reloc` instruction emitted in a call to the [ICeeGen::AddSectionReloc](iceegen-addsectionreloc-method.md) method. - - [COINITICOR Enumeration](coiniticor-enumeration.md) - Specifies constants used by [CoInitializeCor](../hosting/coinitializecor-function.md) when initializing the common language runtime. - - [COINITIEE Enumeration](coinitiee-enumeration.md) - Specifies constants used by [CoInitializeEE](../hosting/coinitializeee-function.md) when initializing the common language runtime. - - [CorArgType Enumeration](corargtype-enumeration.md) - Contains values that describe the native type of a runtime handle. - - [CorAssemblyFlags Enumeration](corassemblyflags-enumeration.md) - Contains values that describe the metadata applied to an assembly compilation. - - [CorAttributeTargets Enumeration](corattributetargets-enumeration.md) - Specifies the application elements on which it is valid to apply an attribute. - - [CorCallingConvention Enumeration](corcallingconvention-enumeration.md) - Contains values that describe the types of calling conventions that are made in managed code. - - [CorCheckDuplicatesFor Enumeration](corcheckduplicatesfor-enumeration.md) - Contains values used during checks for duplications. - - [CorDeclSecurity Enumeration](cordeclsecurity-enumeration.md) - Contains values that describe the types of declarative security used by the common language runtime. - - CorElementType - Contains values that describe the underlying native type of a common language runtime . - - [CorErrorIfEmitOutOfOrder Enumeration](corerrorifemitoutoforder-enumeration.md) - Contains flag values that indicate the conditions under which an error message should be generated when metadata is emitted out of order. - - [CorEventAttr Enumeration](coreventattr-enumeration.md) - Contains values that describe the metadata of an event. - - [CorFieldAttr Enumeration](corfieldattr-enumeration.md) - Contains values that describe metadata about a field. - - [CorFileFlags Enumeration](corfileflags-enumeration.md) - Contains values that describe the type of file defined in a call to the [IMetaDataAssemblyEmit::DefineFile](imetadataassemblyemit-definefile-method.md) method. - - [CorFileMapping Enumeration](corfilemapping-enumeration.md) - Contains values that describe the type of file mapping that is returned from a call to the [IMetaDataInfo::GetFileMapping](imetadatainfo-getfilemapping-method.md) method. - - [CorGenericParamAttr Enumeration](corgenericparamattr-enumeration.md) - Contains values that describe the parameters for generic types, as used in calls to the [IMetaDataEmit2::DefineGenericParam](imetadataemit2-definegenericparam-method.md) method. - - [CorImportOptions Enumeration](corimportoptions-enumeration.md) - Contains flag values that control the behavior during importation of an assembly outside the current scope. - - [CorLinkerOptions Enumeration](corlinkeroptions-enumeration.md) - Specifies flags to select options for the metadata linker. - - [CorLocalRefPreservation Enumeration](corlocalrefpreservation-enumeration.md) - Contains flag values for the treatment of local references. - - [CorManifestResourceFlags Enumeration](cormanifestresourceflags-enumeration.md) - Contains values that describe the visibility of resources encoded in an assembly manifest. - - [CorMethodAttr Enumeration](cormethodattr-enumeration.md) - Contains values that describe metadata about a method. - - [CorMethodImpl Enumeration](cormethodimpl-enumeration.md) - Contains values that describe method implementation features. - - [CorMethodSemanticsAttr Enumeration](cormethodsemanticsattr-enumeration.md) - Contains values that describe the relationship between a method and an associated property or event. - - [CorNativeLinkFlags Enumeration](cornativelinkflags-enumeration.md) - Provides flag values used by the linker when linking native code. - - [CorNativeLinkType Enumeration](cornativelinktype-enumeration.md) - Provides values that indicate the type linked in native code. - - [CorNativeType Enumeration](cornativetype-enumeration.md) - Contains values that describe native unmanaged types. - - [CorNotificationForTokenMovement Enumeration](cornotificationfortokenmovement-enumeration.md) - Contains flag values that influence notifications upon token movement. - - [CorOpenFlags Enumeration](coropenflags-enumeration.md) - Contains flag values that control metadata behavior upon opening manifest files. - - [CorParamAttr Enumeration](corparamattr-enumeration.md) - Contains values that describe the metadata of a method parameter. - - [CorPEKind Enumeration](corpekind-enumeration.md) - Contains values that describe a portable executable file, as returned from a call to the [IMetaDataImport2::GetPEKind](imetadataimport2-getpekind-method.md) method. - - [CorPinvokeMap Enumeration](corpinvokemap-enumeration.md) - Contains values that describe features of a PInvoke call. - - [CorPropertyAttr Enumeration](corpropertyattr-enumeration.md) - Contains values that describe the metadata of a property. - - [CorRefToDefCheck Enumeration](correftodefcheck-enumeration.md) - Specifies flags to control which referenced items are converted to their definitions in order to optimize the code. - - [CorRegFlags Enumeration](corregflags-enumeration.md) - Provides flag values used for registration when installing a module or composite. - - [CorSaveSize Enumeration](corsavesize-enumeration.md) - Contains values indicating the level of precision required when querying for the size of a save operation. - - [CorSerializationType Enumeration](corserializationtype-enumeration.md) - Contains values that describe how an object is serialized by the common language runtime. These values generally correspond to CorElementType values. - - [CorSetENC Enumeration](corsetenc-enumeration.md) - Contains values used to influence behavior during the generation of metadata. - - [CorThreadSafetyOptions Enumeration](corthreadsafetyoptions-enumeration.md) - Specifies flags to select options for thread safety. - - [CorTokenType Enumeration](cortokentype-enumeration.md) - Contains values that indicate the kind of object that a metadata token references. - - [CorTypeAttr Enumeration](cortypeattr-enumeration.md) - Contains values that indicate type metadata. - - [CorUnmanagedCallingConvention Enumeration](corunmanagedcallingconvention-enumeration.md) - Contains values that describe unmanaged calling conventions. - - [CorValidatorModuleType Enumeration](corvalidatormoduletype-enumeration.md) - Provides values used by the [IMetaDataValidate](imetadatavalidate-interface.md) interface to specify the type of the module (PE file vs. .obj file). - - [COUNINITIEE Enumeration](couninitiee-enumeration.md) - Specifies constants used by [CoUninitializeEE](../hosting/couninitializeee-function.md) when initializing the common language runtime. - -## Related Sections - - [Metadata Interfaces](metadata-interfaces.md) - - [Metadata Global Static Functions](metadata-global-static-functions.md) - - [Metadata Structures](metadata-structures.md) - - [Metadata Unions](metadata-unions.md) diff --git a/docs/framework/unmanaged-api/metadata/metadata-global-static-functions.md b/docs/framework/unmanaged-api/metadata/metadata-global-static-functions.md deleted file mode 100644 index 10f704ae262ec..0000000000000 --- a/docs/framework/unmanaged-api/metadata/metadata-global-static-functions.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Learn more about: Metadata Global Static Functions" -title: "Metadata Global Static Functions" -ms.date: "03/30/2017" -helpviewer_keywords: - - "global static functions [.NET Framework metadata]" - - "unmanaged global static functions [.NET Framework], metadata" - - "metadata global static functions [.NET Framework]" -ms.assetid: d3bbc8a7-b1c7-494f-b1cc-d71cf2ecb1bc ---- -# Metadata Global Static Functions - -Beginning with the .NET Framework 4, the documentation for the `_Cor*`, `CoInitialize*`, `CoUninitialize*`, and `CoEEShutDownCOM` functions, which pertain to hosting, is located in [Deprecated CLR Hosting Functions](../hosting/deprecated-clr-hosting-functions.md). There are no global static functions that pertain to metadata. - -## Related Sections - - [Metadata Interfaces](metadata-interfaces.md) - - [Metadata Enumerations](metadata-enumerations.md) - - [Metadata Structures](metadata-structures.md) - - [Metadata Unions](metadata-unions.md) diff --git a/docs/framework/unmanaged-api/metadata/metadata-structures.md b/docs/framework/unmanaged-api/metadata/metadata-structures.md deleted file mode 100644 index 64e3c650f2a38..0000000000000 --- a/docs/framework/unmanaged-api/metadata/metadata-structures.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -description: "Learn more about: Metadata Structures" -title: "Metadata Structures" -ms.date: "03/30/2017" -helpviewer_keywords: - - "structures [.NET Framework metadata]" - - "unmanaged structures [.NET Framework], metadata" - - "metadata structures [.NET Framework]" -ms.assetid: 3eeaec36-5e1a-4a62-9de3-ea3942f67d04 ---- -# Metadata Structures - -This section describes the unmanaged structures that the metadata API uses. - -## In This Section - - ASSEMBLYMETADATA - Stores assembly metadata for later use. - - [COR_FIELD_OFFSET Structure](cor-field-offset-structure.md) - Stores the offset, within a class, of the specified field. - - [COR_NATIVE_LINK Structure](cor-native-link-structure.md) - Contains information that is used to link native code. - - [CVStruct Structure](cvstruct-structure.md) - Contains information that is used when installing a module or a composite image. - - [OSINFO Structure](osinfo-structure.md) - Contains information about the operating system. - -## Related Sections - - [Metadata Interfaces](metadata-interfaces.md) - - [Metadata Global Static Functions](metadata-global-static-functions.md) - - [Metadata Enumerations](metadata-enumerations.md) - - [Metadata Unions](metadata-unions.md) diff --git a/docs/framework/unmanaged-api/metadata/metadata-unions.md b/docs/framework/unmanaged-api/metadata/metadata-unions.md deleted file mode 100644 index 04f60f4b64d25..0000000000000 --- a/docs/framework/unmanaged-api/metadata/metadata-unions.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -description: "Learn more about: Metadata Unions" -title: "Metadata Unions" -ms.date: "03/30/2017" -helpviewer_keywords: - - "unmanaged unions [.NET Framework], metadata" - - "unions [.NET Framework metadata]" - - "metadata unions [.NET Framework]" -ms.assetid: 2c7534cf-34fa-470a-b29e-6cf5a7bd03d3 ---- -# Metadata Unions - -This section describes the unmanaged unions that the metadata API uses. - -## In This Section - - [CeeSectionRelocExtra Union](ceesectionrelocextra-union.md) - Represents an address offset that is used by the [ICeeGen](iceegen-interface.md) interface to relocate a section - -## Related Sections - - [Metadata Interfaces](metadata-interfaces.md) - - [Metadata Global Static Functions](metadata-global-static-functions.md) - - [Metadata Enumerations](metadata-enumerations.md) - - [Metadata Structures](metadata-structures.md) diff --git a/docs/framework/unmanaged-api/metadata/toc.yml b/docs/framework/unmanaged-api/metadata/toc.yml deleted file mode 100644 index 1acc1f731fb58..0000000000000 --- a/docs/framework/unmanaged-api/metadata/toc.yml +++ /dev/null @@ -1,591 +0,0 @@ -items: -- name: Metadata - href: index.md -- name: Metadata Interfaces - href: metadata-interfaces.md - items: - - name: ICeeGen Interface - href: iceegen-interface.md - items: - - name: AddSectionReloc Method - href: iceegen-addsectionreloc-method.md - - name: AllocateMethodBuffer Method - href: iceegen-allocatemethodbuffer-method.md - - name: ComputePointer Method - href: iceegen-computepointer-method.md - - name: EmitString Method - href: iceegen-emitstring-method.md - - name: GenerateCeeFile Method - href: iceegen-generateceefile-method.md - - name: GenerateCeeMemoryImage Method - href: iceegen-generateceememoryimage-method.md - - name: GetIlSection Method - href: iceegen-getilsection-method.md - - name: GetIMapTokenIface Method - href: iceegen-getimaptokeniface-method.md - - name: GetMethodBuffer Method - href: iceegen-getmethodbuffer-method.md - - name: GetSectionBlock Method - href: iceegen-getsectionblock-method.md - - name: GetSectionCreate Method - href: iceegen-getsectioncreate-method.md - - name: GetSectionDataLen Method - href: iceegen-getsectiondatalen-method.md - - name: GetString Method - href: iceegen-getstring-method.md - - name: GetStringSection Method - href: iceegen-getstringsection-method.md - - name: TruncateSection Method - href: iceegen-truncatesection-method.md - - name: IHostFilter Interface - href: ihostfilter-interface.md - items: - - name: MarkToken Method - href: ihostfilter-marktoken-method.md - - name: IMapToken Interface - href: imaptoken-interface.md - items: - - name: Map Method - href: imaptoken-map-method.md - - name: IMetaDataAssemblyEmit Interface - href: imetadataassemblyemit-interface.md - items: - - name: DefineAssembly Method - href: imetadataassemblyemit-defineassembly-method.md - - name: DefineAssemblyRef Method - href: imetadataassemblyemit-defineassemblyref-method.md - - name: DefineExportedType Method - href: imetadataassemblyemit-defineexportedtype-method.md - - name: DefineFile Method - href: imetadataassemblyemit-definefile-method.md - - name: DefineManifestResource Method - href: imetadataassemblyemit-definemanifestresource-method.md - - name: SetAssemblyProps Method - href: imetadataassemblyemit-setassemblyprops-method.md - - name: SetAssemblyRefProps Method - href: imetadataassemblyemit-setassemblyrefprops-method.md - - name: SetExportedTypeProps Method - href: imetadataassemblyemit-setexportedtypeprops-method.md - - name: SetFileProps Method - href: imetadataassemblyemit-setfileprops-method.md - - name: SetManifestResourceProps Method - href: imetadataassemblyemit-setmanifestresourceprops-method.md - - name: IMetaDataAssemblyImport Interface - href: imetadataassemblyimport-interface.md - items: - - name: CloseEnum Method - href: imetadataassemblyimport-closeenum-method.md - - name: EnumAssemblyRefs Method - href: imetadataassemblyimport-enumassemblyrefs-method.md - - name: EnumExportedTypes Method - href: imetadataassemblyimport-enumexportedtypes-method.md - - name: EnumFiles Method - href: imetadataassemblyimport-enumfiles-method.md - - name: EnumManifestResources Method - href: imetadataassemblyimport-enummanifestresources-method.md - - name: FindAssembliesByName Method - href: imetadataassemblyimport-findassembliesbyname-method.md - - name: FindExportedTypeByName Method - href: imetadataassemblyimport-findexportedtypebyname-method.md - - name: FindManifestResourceByName Method - href: imetadataassemblyimport-findmanifestresourcebyname-method.md - - name: GetAssemblyFromScope Method - href: imetadataassemblyimport-getassemblyfromscope-method.md - - name: GetAssemblyProps Method - href: imetadataassemblyimport-getassemblyprops-method.md - - name: GetAssemblyRefProps Method - href: imetadataassemblyimport-getassemblyrefprops-method.md - - name: GetExportedTypeProps Method - href: imetadataassemblyimport-getexportedtypeprops-method.md - - name: GetFileProps Method - href: imetadataassemblyimport-getfileprops-method.md - - name: GetManifestResourceProps Method - href: imetadataassemblyimport-getmanifestresourceprops-method.md - - name: IMetaDataConverter Interface - href: imetadataconverter-interface.md - items: - - name: GetMetaDataFromTypeInfo Method - href: imetadataconverter-getmetadatafromtypeinfo-method.md - - name: GetMetaDataFromTypeLib Method - href: imetadataconverter-getmetadatafromtypelib-method.md - - name: GetTypeLibFromMetaData Method - href: imetadataconverter-gettypelibfrommetadata-method.md - - name: IMetaDataDispenser Interface - href: imetadatadispenser-interface.md - items: - - name: DefineScope Method - href: imetadatadispenser-definescope-method.md - - name: OpenScope Method - href: imetadatadispenser-openscope-method.md - - name: OpenScopeOnMemory Method - href: imetadatadispenser-openscopeonmemory-method.md - - name: IMetaDataDispenserEx Interface - href: imetadatadispenserex-interface.md - items: - - name: FindAssembly Method - href: imetadatadispenserex-findassembly-method.md - - name: FindAssemblyModule Method - href: imetadatadispenserex-findassemblymodule-method.md - - name: GetCORSystemDirectory Method - href: imetadatadispenserex-getcorsystemdirectory-method.md - - name: GetOption Method - href: imetadatadispenserex-getoption-method.md - - name: OpenScopeOnITypeInfo Method - href: imetadatadispenserex-openscopeonitypeinfo-method.md - - name: SetOption Method - href: imetadatadispenserex-setoption-method.md - - name: IMetaDataEmit Interface - href: imetadataemit-interface.md - items: - - name: ApplyEditAndContinue Method - href: imetadataemit-applyeditandcontinue-method.md - - name: DefineCustomAttribute Method - href: imetadataemit-definecustomattribute-method.md - - name: DefineEvent Method - href: imetadataemit-defineevent-method.md - - name: DefineField Method - href: imetadataemit-definefield-method.md - - name: DefineImportMember Method - href: imetadataemit-defineimportmember-method.md - - name: DefineImportType Method - href: imetadataemit-defineimporttype-method.md - - name: DefineMemberRef Method - href: imetadataemit-definememberref-method.md - - name: DefineMethod Method - href: imetadataemit-definemethod-method.md - - name: DefineMethodImpl Method - href: imetadataemit-definemethodimpl-method.md - - name: DefineModuleRef Method - href: imetadataemit-definemoduleref-method.md - - name: DefineNestedType Method - href: imetadataemit-definenestedtype-method.md - - name: DefineParam Method - href: imetadataemit-defineparam-method.md - - name: DefinePermissionSet Method - href: imetadataemit-definepermissionset-method.md - - name: DefinePinvokeMap Method - href: imetadataemit-definepinvokemap-method.md - - name: DefineProperty Method - href: imetadataemit-defineproperty-method.md - - name: DefineSecurityAttributeSet Method - href: imetadataemit-definesecurityattributeset-method.md - - name: DefineTypeDef Method - href: imetadataemit-definetypedef-method.md - - name: DefineTypeRefByName Method - href: imetadataemit-definetyperefbyname-method.md - - name: DefineUserString Method - href: imetadataemit-defineuserstring-method.md - - name: DeleteClassLayout Method - href: imetadataemit-deleteclasslayout-method.md - - name: DeleteFieldMarshal Method - href: imetadataemit-deletefieldmarshal-method.md - - name: DeletePinvokeMap Method - href: imetadataemit-deletepinvokemap-method.md - - name: DeleteToken Method - href: imetadataemit-deletetoken-method.md - - name: GetSaveSize Method - href: imetadataemit-getsavesize-method.md - - name: GetTokenFromSig Method - href: imetadataemit-gettokenfromsig-method.md - - name: GetTokenFromTypeSpec Method - href: imetadataemit-gettokenfromtypespec-method.md - - name: Merge Method - href: imetadataemit-merge-method.md - - name: MergeEnd Method - href: imetadataemit-mergeend-method.md - - name: Save Method - href: imetadataemit-save-method.md - - name: SaveToMemory Method - href: imetadataemit-savetomemory-method.md - - name: SaveToStream Method - href: imetadataemit-savetostream-method.md - - name: SetClassLayout Method - href: imetadataemit-setclasslayout-method.md - - name: SetCustomAttributeValue Method - href: imetadataemit-setcustomattributevalue-method.md - - name: SetEventProps Method - href: imetadataemit-seteventprops-method.md - - name: SetFieldMarshal Method - href: imetadataemit-setfieldmarshal-method.md - - name: SetFieldProps Method - href: imetadataemit-setfieldprops-method.md - - name: SetFieldRVA Method - href: imetadataemit-setfieldrva-method.md - - name: SetHandler Method - href: imetadataemit-sethandler-method.md - - name: SetMethodImplFlags Method - href: imetadataemit-setmethodimplflags-method.md - - name: SetMethodProps Method - href: imetadataemit-setmethodprops-method.md - - name: SetModuleProps Method - href: imetadataemit-setmoduleprops-method.md - - name: SetParamProps Method - href: imetadataemit-setparamprops-method.md - - name: SetParent Method - href: imetadataemit-setparent-method.md - - name: SetPermissionSetProps Method - href: imetadataemit-setpermissionsetprops-method.md - - name: SetPinvokeMap Method - href: imetadataemit-setpinvokemap-method.md - - name: SetPropertyProps Method - href: imetadataemit-setpropertyprops-method.md - - name: SetRVA Method - href: imetadataemit-setrva-method.md - - name: SetTypeDefProps Method - href: imetadataemit-settypedefprops-method.md - - name: TranslateSigWithScope Method - href: imetadataemit-translatesigwithscope-method.md - - name: IMetaDataEmit2 Interface - href: imetadataemit2-interface.md - items: - - name: DefineGenericParam Method - href: imetadataemit2-definegenericparam-method.md - - name: DefineMethodSpec Method - href: imetadataemit2-definemethodspec-method.md - - name: GetDeltaSaveSize Method - href: imetadataemit2-getdeltasavesize-method.md - - name: ResetENCLog Method - href: imetadataemit2-resetenclog-method.md - - name: SaveDelta Method - href: imetadataemit2-savedelta-method.md - - name: SaveDeltaToMemory Method - href: imetadataemit2-savedeltatomemory-method.md - - name: SaveDeltaToStream Method - href: imetadataemit2-savedeltatostream-method.md - - name: SetGenericParamProps Method - href: imetadataemit2-setgenericparamprops-method.md - - name: IMetaDataError Interface - href: imetadataerror-interface.md - items: - - name: OnError Method - href: imetadataerror-onerror-method.md - - name: IMetaDataFilter Interface - href: imetadatafilter-interface.md - items: - - name: IsTokenMarked Method - href: imetadatafilter-istokenmarked-method.md - - name: MarkToken Method - href: imetadatafilter-marktoken-method.md - - name: UnmarkAll Method - href: imetadatafilter-unmarkall-method.md - - name: IMetaDataImport Interface - href: imetadataimport-interface.md - items: - - name: CloseEnum Method - href: imetadataimport-closeenum-method.md - - name: CountEnum Method - href: imetadataimport-countenum-method.md - - name: EnumCustomAttributes Method - href: imetadataimport-enumcustomattributes-method.md - - name: EnumEvents Method - href: imetadataimport-enumevents-method.md - - name: EnumFields Method - href: imetadataimport-enumfields-method.md - - name: EnumFieldsWithName Method - href: imetadataimport-enumfieldswithname-method.md - - name: EnumInterfaceImpls Method - href: imetadataimport-enuminterfaceimpls-method.md - - name: EnumMemberRefs Method - href: imetadataimport-enummemberrefs-method.md - - name: EnumMembers Method - href: imetadataimport-enummembers-method.md - - name: EnumMembersWithName Method - href: imetadataimport-enummemberswithname-method.md - - name: EnumMethodImpls Method - href: imetadataimport-enummethodimpls-method.md - - name: EnumMethods Method - href: imetadataimport-enummethods-method.md - - name: EnumMethodSemantics Method - href: imetadataimport-enummethodsemantics-method.md - - name: EnumMethodsWithName Method - href: imetadataimport-enummethodswithname-method.md - - name: EnumModuleRefs Method - href: imetadataimport-enummodulerefs-method.md - - name: EnumParams Method - href: imetadataimport-enumparams-method.md - - name: EnumPermissionSets Method - href: imetadataimport-enumpermissionsets-method.md - - name: EnumProperties Method - href: imetadataimport-enumproperties-method.md - - name: EnumSignatures Method - href: imetadataimport-enumsignatures-method.md - - name: EnumTypeDefs Method - href: imetadataimport-enumtypedefs-method.md - - name: EnumTypeRefs Method - href: imetadataimport-enumtyperefs-method.md - - name: EnumTypeSpecs Method - href: imetadataimport-enumtypespecs-method.md - - name: EnumUnresolvedMethods Method - href: imetadataimport-enumunresolvedmethods-method.md - - name: EnumUserStrings Method - href: imetadataimport-enumuserstrings-method.md - - name: FindField Method - href: imetadataimport-findfield-method.md - - name: FindMember Method - href: imetadataimport-findmember-method.md - - name: FindMemberRef Method - href: imetadataimport-findmemberref-method.md - - name: FindMethod Method - href: imetadataimport-findmethod-method.md - - name: FindTypeDefByName Method - href: imetadataimport-findtypedefbyname-method.md - - name: FindTypeRef Method - href: imetadataimport-findtyperef-method.md - - name: GetClassLayout Method - href: imetadataimport-getclasslayout-method.md - - name: GetCustomAttributeByName Method - href: imetadataimport-getcustomattributebyname-method.md - - name: GetCustomAttributeProps Method - href: imetadataimport-getcustomattributeprops-method.md - - name: GetEventProps Method - href: imetadataimport-geteventprops-method.md - - name: GetFieldMarshal Method - href: imetadataimport-getfieldmarshal-method.md - - name: GetFieldProps Method - href: imetadataimport-getfieldprops-method.md - - name: GetInterfaceImplProps Method - href: imetadataimport-getinterfaceimplprops-method.md - - name: GetMemberProps Method - href: imetadataimport-getmemberprops-method.md - - name: GetMemberRefProps Method - href: imetadataimport-getmemberrefprops-method.md - - name: GetMethodProps Method - href: imetadataimport-getmethodprops-method.md - - name: GetMethodSemantics Method - href: imetadataimport-getmethodsemantics-method.md - - name: GetModuleFromScope Method - href: imetadataimport-getmodulefromscope-method.md - - name: GetModuleRefProps Method - href: imetadataimport-getmodulerefprops-method.md - - name: GetNameFromToken Method - href: imetadataimport-getnamefromtoken-method.md - - name: GetNativeCallConvFromSig Method - href: imetadataimport-getnativecallconvfromsig-method.md - - name: GetNestedClassProps Method - href: imetadataimport-getnestedclassprops-method.md - - name: GetParamForMethodIndex Method - href: imetadataimport-getparamformethodindex-method.md - - name: GetParamProps Method - href: imetadataimport-getparamprops-method.md - - name: GetPermissionSetProps Method - href: imetadataimport-getpermissionsetprops-method.md - - name: GetPinvokeMap - href: imetadataimport-getpinvokemap-method.md - - name: GetPropertyProps Method - href: imetadataimport-getpropertyprops-method.md - - name: GetRVA Method - href: imetadataimport-getrva-method.md - - name: GetScopeProps Method - href: imetadataimport-getscopeprops-method.md - - name: GetSigFromToken Method - href: imetadataimport-getsigfromtoken-method.md - - name: GetTypeDefProps Method - href: imetadataimport-gettypedefprops-method.md - - name: GetTypeRefProps Method - href: imetadataimport-gettyperefprops-method.md - - name: GetTypeSpecFromToken Method - href: imetadataimport-gettypespecfromtoken-method.md - - name: GetUserString Method - href: imetadataimport-getuserstring-method.md - - name: IsGlobal Method - href: imetadataimport-isglobal-method.md - - name: IsValidToken Method - href: imetadataimport-isvalidtoken-method.md - - name: ResetEnum Method - href: imetadataimport-resetenum-method.md - - name: ResolveTypeRef Method - href: imetadataimport-resolvetyperef-method.md - - name: IMetaDataImport2 Interface - href: imetadataimport2-interface.md - items: - - name: EnumGenericParamConstraints Method - href: imetadataimport2-enumgenericparamconstraints-method.md - - name: EnumGenericParams Method - href: imetadataimport2-enumgenericparams-method.md - - name: EnumMethodSpecs Method - href: imetadataimport2-enummethodspecs-method.md - - name: GetGenericParamConstraintProps Method - href: imetadataimport2-getgenericparamconstraintprops-method.md - - name: GetGenericParamProps Method - href: imetadataimport2-getgenericparamprops-method.md - - name: GetMethodSpecProps Method - href: imetadataimport2-getmethodspecprops-method.md - - name: GetPEKind Method - href: imetadataimport2-getpekind-method.md - - name: GetVersionString Method - href: imetadataimport2-getversionstring-method.md - - name: IMetaDataInfo Interface - href: imetadatainfo-interface.md - items: - - name: GetFileMapping Method - href: imetadatainfo-getfilemapping-method.md - - name: IMetaDataTables Interface - href: imetadatatables-interface.md - items: - - name: GetBlob Method - href: imetadatatables-getblob-method.md - - name: GetBlobHeapSize Method - href: imetadatatables-getblobheapsize-method.md - - name: GetCodedTokenInfo Method - href: imetadatatables-getcodedtokeninfo-method.md - - name: GetColumn Method - href: imetadatatables-getcolumn-method.md - - name: GetColumnInfo Method - href: imetadatatables-getcolumninfo-method.md - - name: GetGuid Method - href: imetadatatables-getguid-method.md - - name: GetGuidHeapSize Method - href: imetadatatables-getguidheapsize-method.md - - name: GetNextBlob Method - href: imetadatatables-getnextblob-method.md - - name: GetNextGuid Method - href: imetadatatables-getnextguid-method.md - - name: GetNextString Method - href: imetadatatables-getnextstring-method.md - - name: GetNextUserString Method - href: imetadatatables-getnextuserstring-method.md - - name: GetNumTables Method - href: imetadatatables-getnumtables-method.md - - name: GetRow Method - href: imetadatatables-getrow-method.md - - name: GetString Method - href: imetadatatables-getstring-method.md - - name: GetStringHeapSize Method - href: imetadatatables-getstringheapsize-method.md - - name: GetTableIndex Method - href: imetadatatables-gettableindex-method.md - - name: GetTableInfo Method - href: imetadatatables-gettableinfo-method.md - - name: GetUserString Method - href: imetadatatables-getuserstring-method.md - - name: GetUserStringHeapSize Method - href: imetadatatables-getuserstringheapsize-method.md - - name: IMetaDataTables2 Interface - href: imetadatatables2-interface.md - items: - - name: GetMetaDataStorage Method - href: imetadatatables2-getmetadatastorage-method.md - - name: GetMetaDataStreamInfo Method - href: imetadatatables2-getmetadatastreaminfo-method.md - - name: IMetaDataValidate Interface - href: imetadatavalidate-interface.md - items: - - name: ValidateMetaData Method - href: imetadatavalidate-validatemetadata-method.md - - name: ValidatorInit Method - href: imetadatavalidate-validatorinit-method.md -- name: Metadata Global Static Functions - href: metadata-global-static-functions.md -- name: Metadata Enumerations - href: metadata-enumerations.md - items: - - name: AssemblyFlags Enumeration - href: assemblyflags-enumeration.md - - name: AssemblyRefFlags Enumeration - href: assemblyrefflags-enumeration.md - - name: CeeSectionAttr Enumeration - href: ceesectionattr-enumeration.md - - name: CeeSectionRelocType Enumeration - href: ceesectionreloctype-enumeration.md - - name: COINITICOR Enumeration - href: coiniticor-enumeration.md - - name: COINITIEE Enumeration - href: coinitiee-enumeration.md - - name: CorArgType Enumeration - href: corargtype-enumeration.md - - name: CorAssemblyFlags Enumeration - href: corassemblyflags-enumeration.md - - name: CorAttributeTargets Enumeration - href: corattributetargets-enumeration.md - - name: CorCallingConvention Enumeration - href: corcallingconvention-enumeration.md - - name: CorCheckDuplicatesFor Enumeration - href: corcheckduplicatesfor-enumeration.md - - name: CorDeclSecurity Enumeration - href: cordeclsecurity-enumeration.md - - name: CorElementType Enumeration1 - href: corelementtype-enumeration.md - - name: CorErrorIfEmitOutOfOrder Enumeration - href: corerrorifemitoutoforder-enumeration.md - - name: CorEventAttr Enumeration - href: coreventattr-enumeration.md - - name: CorFieldAttr Enumeration - href: corfieldattr-enumeration.md - - name: CorFileFlags Enumeration - href: corfileflags-enumeration.md - - name: CorFileMapping Enumeration - href: corfilemapping-enumeration.md - - name: CorGenericParamAttr Enumeration - href: corgenericparamattr-enumeration.md - - name: CorImportOptions Enumeration - href: corimportoptions-enumeration.md - - name: CorLinkerOptions Enumeration - href: corlinkeroptions-enumeration.md - - name: CorLocalRefPreservation Enumeration - href: corlocalrefpreservation-enumeration.md - - name: CorManifestResourceFlags Enumeration - href: cormanifestresourceflags-enumeration.md - - name: CorMethodAttr Enumeration - href: cormethodattr-enumeration.md - - name: CorMethodImpl Enumeration - href: cormethodimpl-enumeration.md - - name: CorMethodSemanticsAttr Enumeration - href: cormethodsemanticsattr-enumeration.md - - name: CorNativeLinkFlags Enumeration - href: cornativelinkflags-enumeration.md - - name: CorNativeLinkType Enumeration - href: cornativelinktype-enumeration.md - - name: CorNativeType Enumeration - href: cornativetype-enumeration.md - - name: CorNotificationForTokenMovement Enumeration - href: cornotificationfortokenmovement-enumeration.md - - name: CorOpenFlags Enumeration - href: coropenflags-enumeration.md - - name: CorParamAttr Enumeration - href: corparamattr-enumeration.md - - name: CorPEKind Enumeration - href: corpekind-enumeration.md - - name: CorPinvokeMap Enumeration - href: corpinvokemap-enumeration.md - - name: CorPropertyAttr Enumeration - href: corpropertyattr-enumeration.md - - name: CorRefToDefCheck Enumeration - href: correftodefcheck-enumeration.md - - name: CorRegFlags Enumeration - href: corregflags-enumeration.md - - name: CorSaveSize Enumeration - href: corsavesize-enumeration.md - - name: CorSerializationType Enumeration - href: corserializationtype-enumeration.md - - name: CorSetENC Enumeration - href: corsetenc-enumeration.md - - name: CorThreadSafetyOptions Enumeration - href: corthreadsafetyoptions-enumeration.md - - name: CorTokenType Enumeration - href: cortokentype-enumeration.md - - name: CorTypeAttr Enumeration - href: cortypeattr-enumeration.md - - name: CorUnmanagedCallingConvention Enumeration - href: corunmanagedcallingconvention-enumeration.md - - name: CorValidatorModuleType Enumeration - href: corvalidatormoduletype-enumeration.md - - name: COUNINITIEE Enumeration - href: couninitiee-enumeration.md -- name: Metadata Structures - href: metadata-structures.md - items: - - name: ASSEMBLYMETADATA Structure - href: assemblymetadata-structure.md - - name: COR_FIELD_OFFSET Structure - href: cor-field-offset-structure.md - - name: COR_NATIVE_LINK Structure - href: cor-native-link-structure.md - - name: CVStruct Structure - href: cvstruct-structure.md - - name: OSINFO Structure - href: osinfo-structure.md -- name: Metadata Unions - href: metadata-unions.md - items: - - name: CeeSectionRelocExtra Union - href: ceesectionrelocextra-union.md diff --git a/docs/framework/unmanaged-api/profiling/clr-profilers-and-windows-store-apps.md b/docs/framework/unmanaged-api/profiling/clr-profilers-and-windows-store-apps.md index 3a1f60ae3301a..257ef9d73ade2 100644 --- a/docs/framework/unmanaged-api/profiling/clr-profilers-and-windows-store-apps.md +++ b/docs/framework/unmanaged-api/profiling/clr-profilers-and-windows-store-apps.md @@ -16,23 +16,20 @@ helpviewer_keywords: # CLR Profilers and Windows Store Apps -This topic discusses what you need to think about when writing diagnostic tools that analyze managed code running inside a Windows Store app. It also provides guidelines to modify your existing development tools so they continue to work when you run them against Windows Store apps. To understand this information, it’s best if you're familiar with the Common Language Runtime Profiling API, you’ve already used this API in a diagnostic tool that runs correctly against Windows desktop applications, and you’re now interested in modifying the tool to run correctly against Windows Store apps. +This topic discusses what you need to think about when writing diagnostic tools that analyze managed code running inside a Windows Store app. It also provides guidelines to modify your existing development tools so they continue to work when you run them against Windows Store apps. To understand this information, it's best if you're familiar with the Common Language Runtime Profiling API, you've already used this API in a diagnostic tool that runs correctly against Windows desktop applications, and you're now interested in modifying the tool to run correctly against Windows Store apps. ## Introduction -If you made it past the introductory paragraph, then you’re familiar with the CLR Profiling API. You’ve already written a diagnostic tool that works well against managed desktop applications. Now you’re curious what to do so that your tool works with a managed Windows Store app. Perhaps you’ve already tried to make this work, and have discovered that it’s not a straightforward task. Indeed, there are a number of considerations that might not be obvious to all tools developers. For example: +If you made it past the introductory paragraph, then you're familiar with the CLR Profiling API. You've already written a diagnostic tool that works well against managed desktop applications. Now you're curious what to do so that your tool works with a managed Windows Store app. Perhaps you've already tried to make this work, and have discovered that it's not a straightforward task. Indeed, there are a number of considerations that might not be obvious to all tools developers. For example: - Windows Store apps run in a context with severely reduced permissions. - - Windows Metadata files have unique characteristics when compared to traditional managed modules. - - Windows Store apps have a habit of suspending themselves when interactivity goes down. - - Your inter-process communication mechanisms may no longer work for various reasons. -This topic lists the things you need to be aware of and how to deal with them properly. +This article lists the things you need to be aware of and how to deal with them properly. -If you’re new to the CLR Profiling API, skip down to the Resources at the end of this topic to find better introductory information. +If you're new to the CLR Profiling API, skip down to the Resources at the end of this topic to find better introductory information. Providing detail about specific Windows APIs and how they should be used is also outside the scope of this topic. Consider this topic a starting point, and refer to MSDN to learn more about any Windows APIs referenced here. @@ -44,24 +41,24 @@ The following terminology is used throughout this topic: **Application** -This is the application that the profiler is analyzing. Typically, the developer of this application is now using the profiler to help diagnose issues with the application. Traditionally, this application would be a Windows desktop application, but in this topic, we’re looking at Windows Store apps. +This is the application that the profiler is analyzing. Typically, the developer of this application is now using the profiler to help diagnose issues with the application. Traditionally, this application would be a Windows desktop application, but in this topic, we're looking at Windows Store apps. **Profiler DLL** -This is the component that loads into the process space of the application being analyzed. This component, also known as the profiler "agent," implements the [ICorProfilerCallback](icorprofilercallback-interface.md)[ICorProfilerCallback Interface](icorprofilercallback-interface.md)(2,3,etc.) interfaces and consumes the [ICorProfilerInfo](icorprofilerinfo-interface.md)(2,3,etc.) interfaces to collect data about the analyzed application and potentially modify aspects of the application’s behavior. +This is the component that loads into the process space of the application being analyzed. This component, also known as the profiler "agent," implements the [ICorProfilerCallback](icorprofilercallback-interface.md)[ICorProfilerCallback Interface](icorprofilercallback-interface.md)(2,3,etc.) interfaces and consumes the [ICorProfilerInfo](icorprofilerinfo-interface.md)(2,3,etc.) interfaces to collect data about the analyzed application and potentially modify aspects of the application's behavior. **Profiler UI** -This is a desktop application that the profiler user interacts with. It’s responsible for displaying application status to the user and giving the user the means to control the behavior of the analyzed application. This component always runs in its own process space, separate from the process space of the application being profiled. The Profiler UI can also act as the "attach trigger," which is the process that calls the [ICLRProfiling::AttachProfiler](iclrprofiling-attachprofiler-method.md) method, to cause the analyzed application to load the Profiler DLL in those cases where the profiler DLL did not load on startup. +This is a desktop application that the profiler user interacts with. It's responsible for displaying application status to the user and giving the user the means to control the behavior of the analyzed application. This component always runs in its own process space, separate from the process space of the application being profiled. The Profiler UI can also act as the "attach trigger," which is the process that calls the [ICLRProfiling::AttachProfiler](iclrprofiling-attachprofiler-method.md) method, to cause the analyzed application to load the Profiler DLL in those cases where the profiler DLL did not load on startup. > [!IMPORTANT] -> Your Profiler UI should remain a Windows desktop application, even when it is used to control and report on a Windows Store app. Don’t expect to be able to package and ship your diagnostics tool in the Windows Store. Your tool needs to do things that Windows Store apps cannot do, and many of those things reside inside your Profiler UI. +> Your Profiler UI should remain a Windows desktop application, even when it is used to control and report on a Windows Store app. Don't expect to be able to package and ship your diagnostics tool in the Windows Store. Your tool needs to do things that Windows Store apps cannot do, and many of those things reside inside your Profiler UI. Throughout this document, the sample code assumes that: - Your Profiler DLL is written in C++, because it must be a native DLL, as per the requirements of the CLR Profiling API. -- Your Profiler UI is written in C#. This isn’t necessary, but because there are no requirements on the language for your Profiler UI’s process, why not pick a language that’s concise and simple? +- Your Profiler UI is written in C#. This isn't necessary, but because there are no requirements on the language for your Profiler UI's process, why not pick a language that's concise and simple? ### Windows RT devices @@ -69,21 +66,21 @@ Windows RT devices are quite locked down. Third-party profilers simply cannot be ## Consuming Windows Runtime APIs -In a number of scenarios discussed in the following sections, your Profiler UI desktop application needs to consume some new Windows Runtime APIs. You’ll want to consult the documentation to understand which Windows Runtime APIs can be used from desktop applications, and whether their behavior is different when called from desktop applications and Windows Store apps. +In a number of scenarios discussed in the following sections, your Profiler UI desktop application needs to consume some new Windows Runtime APIs. You'll want to consult the documentation to understand which Windows Runtime APIs can be used from desktop applications, and whether their behavior is different when called from desktop applications and Windows Store apps. -If your Profiler UI is written in managed code, there will be a few steps you’ll need to do to make consuming those Windows Runtime APIs easy. For more information, see the [Managed desktop apps and Windows Runtime](/previous-versions/windows/apps/jj856306(v=win.10)) article. +If your Profiler UI is written in managed code, there will be a few steps you'll need to do to make consuming those Windows Runtime APIs easy. For more information, see the [Managed desktop apps and Windows Runtime](/previous-versions/windows/apps/jj856306(v=win.10)) article. ## Loading the Profiler DLL This section describes how your Profiler UI causes the Windows Store app to load your Profiler DLL. The code discussed in this section belongs in your Profiler UI desktop app, and therefore involves using Windows APIs that are safe for desktop apps but not necessarily safe for Windows Store apps. -Your Profiler UI can cause your Profiler DLL to be loaded into the application’s process space in two ways: +Your Profiler UI can cause your Profiler DLL to be loaded into the application's process space in two ways: - At application startup, as controlled by environment variables. - By attaching to the application after startup is complete by calling the [ICLRProfiling::AttachProfiler](iclrprofiling-attachprofiler-method.md) method. -One of your first roadblocks will be getting startup-load and attach-load of your Profiler DLL to work properly with Windows Store apps. Both forms of loading share some special considerations in common, so let’s start with them. +One of your first roadblocks will be getting startup-load and attach-load of your Profiler DLL to work properly with Windows Store apps. Both forms of loading share some special considerations in common, so let's start with them. ### Common considerations for startup and attach loads @@ -97,7 +94,7 @@ When Windows attempts to load your Profiler DLL, it verifies that your Profiler **File system permissions** -The Windows Store app must have permission to load and execute your Profiler DLL from the location on the file system in which it residesBy default, the Windows Store app doesn’t have such permission on most directories, and any failed attempt to load your Profiler DLL will produce an entry in the Windows Application event log that looks something like this: +The Windows Store app must have permission to load and execute your Profiler DLL from the location on the file system in which it residesBy default, the Windows Store app doesn't have such permission on most directories, and any failed attempt to load your Profiler DLL will produce an entry in the Windows Application event log that looks something like this: ```output NET Runtime version 4.0.30319.17929 - Loading profiler failed during CoCreateInstance. Profiler CLSID: '{xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}'. HRESULT: 0x80070005. Process ID (decimal): 4688. Message ID: [0x2504]. @@ -109,13 +106,13 @@ Generally, Windows Store apps are only allowed to access a limited set of locati Typically, in a desktop app, your Profiler UI prompts a startup load of your Profiler DLL by initializing an environment block that contains the required CLR Profiling API environment variables (i.e., `COR_PROFILER`, `COR_ENABLE_PROFILING`, and `COR_PROFILER_PATH`), and then creating a new process with that environment block. The same holds true for Windows Store apps, but the mechanisms are different. -**Don’t run elevated** +**Don't run elevated** If Process A attempts to spawn Windows Store app Process B, Process A should be run at medium integrity level, not at high integrity level (that is, not elevated). This means that either your Profiler UI should be running at medium integrity level, or it must spawn another desktop process at medium integrity level to take care of launching the Windows Store app. **Choosing a Windows Store App to profile** -First, you’ll want to ask your profiler user which Windows Store app to launch. For desktop apps, perhaps you’d show a file Browse dialog, and the user would find and select an .exe file. But Windows Store apps are different, and using a Browse dialog doesn’t make sense. Instead, it’s better to show the user a list of Windows Store apps installed for that user to select from. +First, you'll want to ask your profiler user which Windows Store app to launch. For desktop apps, perhaps you'd show a file Browse dialog, and the user would find and select an .exe file. But Windows Store apps are different, and using a Browse dialog doesn't make sense. Instead, it's better to show the user a list of Windows Store apps installed for that user to select from. You can use the class to generate this list. `PackageManager` is a Windows Runtime class that is available to desktop apps, and in fact it is *only* available to desktop apps. @@ -130,7 +127,7 @@ IEnumerable packages = packageManager.FindPackagesForUser(currentUserSI **Specifying the custom environment block** -A new COM interface, [IPackageDebugSettings](/windows/desktop/api/shobjidl_core/nn-shobjidl_core-ipackagedebugsettings), allows you to customize the execution behavior of a Windows Store app to make some forms of diagnostics easier. One of its methods, [EnableDebugging](/windows/desktop/api/shobjidl_core/nf-shobjidl_core-ipackagedebugsettings-enabledebugging), lets you pass an environment block to the Windows Store app when it’s launched, along with other useful effects like disabling automatic process suspension. The environment block is important because that’s where you need to specify the environment variables (`COR_PROFILER`, `COR_ENABLE_PROFILING`, and `COR_PROFILER_PATH)`) used by the CLR to load your Profiler DLL. +A new COM interface, [IPackageDebugSettings](/windows/desktop/api/shobjidl_core/nn-shobjidl_core-ipackagedebugsettings), allows you to customize the execution behavior of a Windows Store app to make some forms of diagnostics easier. One of its methods, [EnableDebugging](/windows/desktop/api/shobjidl_core/nf-shobjidl_core-ipackagedebugsettings-enabledebugging), lets you pass an environment block to the Windows Store app when it's launched, along with other useful effects like disabling automatic process suspension. The environment block is important because that's where you need to specify the environment variables (`COR_PROFILER`, `COR_ENABLE_PROFILING`, and `COR_PROFILER_PATH)`) used by the CLR to load your Profiler DLL. Consider the following code snippet: @@ -152,7 +149,7 @@ There are a couple of items you'll need to get right: where `-p 1336` means the Windows Store app has Process ID 1336, and `-tid 1424` means Thread ID 1424 is the thread that is suspended. Your dummy debugger would parse the ThreadID from the command-line, resume that thread, and then exit. - Here’s some example C++ code to do this (be sure to add error checking!): + Here's some example C++ code to do this (be sure to add error checking!): ```cpp int wmain(int argc, wchar_t* argv[]) @@ -169,13 +166,13 @@ There are a couple of items you'll need to get right: } ``` - You’ll need to deploy this dummy debugger as part of your diagnostics tool installation, and then specify the path to this debugger in the `debuggerCommandLine` parameter. + You'll need to deploy this dummy debugger as part of your diagnostics tool installation, and then specify the path to this debugger in the `debuggerCommandLine` parameter. **Launching the Windows Store app** -The moment to launch the Windows Store app has finally arrived. If you’ve already tried doing this yourself, you may have noticed that [CreateProcess](/windows/desktop/api/processthreadsapi/nf-processthreadsapi-createprocessa) is not how you create a Windows Store app process. Instead, you’ll need to use the [IApplicationActivationManager::ActivateApplication](/windows/desktop/api/shobjidl_core/nf-shobjidl_core-iapplicationactivationmanager-activateapplication) method. To do that, you’ll need to get the App User Model ID of the Windows Store app that you’re launching. And that means you’ll need to do a little digging through the manifest. +The moment to launch the Windows Store app has finally arrived. If you've already tried doing this yourself, you may have noticed that [CreateProcess](/windows/desktop/api/processthreadsapi/nf-processthreadsapi-createprocessa) is not how you create a Windows Store app process. Instead, you'll need to use the [IApplicationActivationManager::ActivateApplication](/windows/desktop/api/shobjidl_core/nf-shobjidl_core-iapplicationactivationmanager-activateapplication) method. To do that, you'll need to get the App User Model ID of the Windows Store app that you're launching. And that means you'll need to do a little digging through the manifest. -While iterating over your packages (see "Choosing a Windows Store App to Profile" in the [Startup load](#startup-load) section earlier), you’ll want to grab the set of applications contained in the current package’s manifest: +While iterating over your packages (see "Choosing a Windows Store App to Profile" in the [Startup load](#startup-load) section earlier), you'll want to grab the set of applications contained in the current package's manifest: ```csharp string manifestPath = package.InstalledLocation.Path + "\\AppxManifest.xml"; @@ -194,7 +191,7 @@ IAppxManifestReader manifestReader = appxFactory.CreateManifestReader(manifestSt IAppxManifestApplicationsEnumerator appsEnum = manifestReader.GetApplications(); ``` -Yes, one package can have multiple applications, and each application has its own Application User Model ID. So you’ll want to ask your user which application to profile, and grab the Application User Model ID from that particular application: +Yes, one package can have multiple applications, and each application has its own Application User Model ID. So you'll want to ask your user which application to profile, and grab the Application User Model ID from that particular application: ```csharp while (appsEnum.GetHasCurrent() != 0) @@ -222,9 +219,9 @@ When your Profiler UI wants to attach its Profiler DLL to an application that ha **EnableDebugging** -As with startup load, call the [IPackageDebugSettings::EnableDebugging](/windows/desktop/api/shobjidl_core/nf-shobjidl_core-ipackagedebugsettings-enabledebugging) method. You don’t need it for passing an environment block, but you need one of its other features: disabling automatic process suspension. Otherwise, when your Profiler UI calls [AttachProfiler](iclrprofiling-attachprofiler-method.md), the target Windows Store app may be suspended. In fact, this is likely if the user is now interacting with your Profiler UI, and the Windows Store app is not active on any of the user’s screens. And if the Windows Store app is suspended, it won’t be able to respond to any signal that the CLR sends to it to attach your Profiler DLL. +As with startup load, call the [IPackageDebugSettings::EnableDebugging](/windows/desktop/api/shobjidl_core/nf-shobjidl_core-ipackagedebugsettings-enabledebugging) method. You don't need it for passing an environment block, but you need one of its other features: disabling automatic process suspension. Otherwise, when your Profiler UI calls [AttachProfiler](iclrprofiling-attachprofiler-method.md), the target Windows Store app may be suspended. In fact, this is likely if the user is now interacting with your Profiler UI, and the Windows Store app is not active on any of the user's screens. And if the Windows Store app is suspended, it won't be able to respond to any signal that the CLR sends to it to attach your Profiler DLL. -So you’ll want to do something like this: +So you'll want to do something like this: ```csharp IPackageDebugSettings pkgDebugSettings = new PackageDebugSettings(); @@ -232,11 +229,11 @@ pkgDebugSettings.EnableDebugging(packageFullName, null /* debuggerCommandLine */ IntPtr.Zero /* environment */); ``` -This is the same call you’d make for the startup load case, except you don’t specify a debugger command line or an environment block. +This is the same call you'd make for the startup load case, except you don't specify a debugger command line or an environment block. **DisableDebugging** -As always, don’t forget to call [IPackageDebugSettings::DisableDebugging](/windows/desktop/api/shobjidl_core/nf-shobjidl_core-ipackagedebugsettings-disabledebugging) when your profiling session is completed. +As always, don't forget to call [IPackageDebugSettings::DisableDebugging](/windows/desktop/api/shobjidl_core/nf-shobjidl_core-ipackagedebugsettings-disabledebugging) when your profiling session is completed. ## Running inside the Windows Store app @@ -244,11 +241,11 @@ So the Windows Store app has finally loaded your Profiler DLL. Now your Profiler ### Stick to the Windows Store app APIs -As you browse the Windows API, you’ll notice that every API is documented as being applicable to desktop apps, Windows Store apps, or both. For example, the **Requirements** section of the documentation for the [InitializeCriticalSectionAndSpinCount](/windows/desktop/api/synchapi/nf-synchapi-initializecriticalsectionandspincount) function indicates that the function applies to desktop apps only. In contrast, the [InitializeCriticalSectionEx](/windows/desktop/api/synchapi/nf-synchapi-initializecriticalsectionex) function is available for both desktop apps and Windows Store apps. +As you browse the Windows API, you'll notice that every API is documented as being applicable to desktop apps, Windows Store apps, or both. For example, the **Requirements** section of the documentation for the [InitializeCriticalSectionAndSpinCount](/windows/desktop/api/synchapi/nf-synchapi-initializecriticalsectionandspincount) function indicates that the function applies to desktop apps only. In contrast, the [InitializeCriticalSectionEx](/windows/desktop/api/synchapi/nf-synchapi-initializecriticalsectionex) function is available for both desktop apps and Windows Store apps. -When developing your Profiler DLL, treat it as if it’s a Windows Store app and only use APIs that are documented as available to Windows Store apps. Analyze your dependencies (for example, you can run `link /dump /imports` against your Profiler DLL to audit), and then search the docs to see which of your dependencies are ok and which aren’t. In most cases, your violations can be fixed by simply replacing them with a newer form of the API that is documented as safe (for example, replacing [InitializeCriticalSectionAndSpinCount](/windows/desktop/api/synchapi/nf-synchapi-initializecriticalsectionandspincount) with [InitializeCriticalSectionEx](/windows/desktop/api/synchapi/nf-synchapi-initializecriticalsectionex)). +When developing your Profiler DLL, treat it as if it's a Windows Store app and only use APIs that are documented as available to Windows Store apps. Analyze your dependencies (for example, you can run `link /dump /imports` against your Profiler DLL to audit), and then search the docs to see which of your dependencies are ok and which aren't. In most cases, your violations can be fixed by simply replacing them with a newer form of the API that is documented as safe (for example, replacing [InitializeCriticalSectionAndSpinCount](/windows/desktop/api/synchapi/nf-synchapi-initializecriticalsectionandspincount) with [InitializeCriticalSectionEx](/windows/desktop/api/synchapi/nf-synchapi-initializecriticalsectionex)). -You might notice that your Profiler DLL calls some APIs that apply to desktop apps only, and yet they seem to work even when your Profiler DLL is loaded inside a Windows Store app. Be aware that it’s risky to use any API not documented for use with Windows Store apps in your Profiler DLL when loaded into a Windows Store app process: +You might notice that your Profiler DLL calls some APIs that apply to desktop apps only, and yet they seem to work even when your Profiler DLL is loaded inside a Windows Store app. Be aware that it's risky to use any API not documented for use with Windows Store apps in your Profiler DLL when loaded into a Windows Store app process: - Such APIs are not guaranteed to work when called in the unique context that Windows Store apps run in. @@ -262,11 +259,11 @@ You might find that you absolutely cannot do without a particular API and cannot - Test, test, test the living daylights out of your usage of that API. -- Understand that the API might suddenly break or disappear if called from inside Windows Store apps in future releases of Windows. This won’t be considered a compatibility concern by Microsoft, and supporting your usage of it will not be a priority. +- Understand that the API might suddenly break or disappear if called from inside Windows Store apps in future releases of Windows. This won't be considered a compatibility concern by Microsoft, and supporting your usage of it will not be a priority. ### Reduced permissions -It’s outside the scope of this topic to list all the ways that Windows Store app permissions differ from desktop apps. But certainly the behavior will be different every time your Profiler DLL (when loaded into a Windows Store app as compared to a desktop app) tries to access any resources. The file system is the most common example. There are but a few places on disk that a given Windows Store app is allowed to access (see [File access and permissions (Windows Runtime apps](/previous-versions/windows/apps/hh967755(v=win.10))), and your Profiler DLL will be under the same restrictions. Test your code thoroughly. +It's outside the scope of this topic to list all the ways that Windows Store app permissions differ from desktop apps. But certainly the behavior will be different every time your Profiler DLL (when loaded into a Windows Store app as compared to a desktop app) tries to access any resources. The file system is the most common example. There are but a few places on disk that a given Windows Store app is allowed to access (see [File access and permissions (Windows Runtime apps](/previous-versions/windows/apps/hh967755(v=win.10))), and your Profiler DLL will be under the same restrictions. Test your code thoroughly. ### Inter-process communication @@ -308,11 +305,11 @@ CreateEventEx( EVENT_ALL_ACCESS); ``` -Your Profiler UI then needs to find that named event under the Windows Store app’s namespace. For example, your Profiler UI could call [CreateEventEx](/windows/desktop/api/synchapi/nf-synchapi-createeventexa), specifying the event name as +Your Profiler UI then needs to find that named event under the Windows Store app's namespace. For example, your Profiler UI could call [CreateEventEx](/windows/desktop/api/synchapi/nf-synchapi-createeventexa), specifying the event name as `AppContainerNamedObjects\\MyNamedEvent` -`` is the Windows Store app’s AppContainer SID. An earlier section of this topic showed how to iterate over the packages installed for the current user. From that sample code, you can obtain the packageId. And from the packageId, you can obtain the `` with code similar to the following: +`` is the Windows Store app's AppContainer SID. An earlier section of this topic showed how to iterate over the packages installed for the current user. From that sample code, you can obtain the packageId. And from the packageId, you can obtain the `` with code similar to the following: ```csharp IntPtr acPSID; @@ -329,7 +326,7 @@ GetAppContainerFolderPath(acSid, out acDir); When running inside a Windows Store app, your Profiler DLL should not rely on either [ICorProfilerCallback::Shutdown](icorprofilercallback-shutdown-method.md) or even [DllMain](/windows/desktop/Dlls/dllmain) (with `DLL_PROCESS_DETACH`) being called to notify your Profiler DLL that the Windows Store app is exiting. In fact, you should expect they will never be called. Historically, many Profiler DLLs have used those notifications as convenient places to flush caches to disk, close files, send notifications back to the Profiler UI, etc. But now your Profiler DLL needs to be organized a little differently. -Your Profiler DLL should be logging information as it goes. For performance reasons, you may want to batch information in memory and flush it to disk as the batch grows in size past some threshold. But assume that any information not yet flushed to disk can be lost. This means you’ll want to pick your threshold wisely, and that your Profiler UI needs to be hardened to deal with incomplete information written by the Profiler DLL. +Your Profiler DLL should be logging information as it goes. For performance reasons, you may want to batch information in memory and flush it to disk as the batch grows in size past some threshold. But assume that any information not yet flushed to disk can be lost. This means you'll want to pick your threshold wisely, and that your Profiler UI needs to be hardened to deal with incomplete information written by the Profiler DLL. ## Windows Runtime metadata files @@ -337,7 +334,7 @@ It is outside the scope of this document to go into detail on what Windows Runti ### Managed and non-managed WinMDs -If a developer uses Visual Studio to create a new Windows Runtime Component project, a build of that project produces a WinMD file that describes the metadata (the type descriptions of classes, interfaces, etc.) authored by the developer. If this project is a managed language project written in C# or Visual Basic, that same WinMD file also contains the implementation of those types (meaning that it contains all the IL compiled from the developer’s source code). Such files are known as managed WinMD files. They're interesting in that they contain both Windows Runtime metadata and the underlying implementation. +If a developer uses Visual Studio to create a new Windows Runtime Component project, a build of that project produces a WinMD file that describes the metadata (the type descriptions of classes, interfaces, etc.) authored by the developer. If this project is a managed language project written in C# or Visual Basic, that same WinMD file also contains the implementation of those types (meaning that it contains all the IL compiled from the developer's source code). Such files are known as managed WinMD files. They're interesting in that they contain both Windows Runtime metadata and the underlying implementation. In contrast, if a developer creates a Windows Runtime Component project for C++, a build of that project produces a WinMD file that contains only metadata, and the implementation is compiled into a separate native DLL. Similarly, the WinMD files that ship in the Windows SDK contain only metadata, with the implementation compiled into separate native DLLs that ship as part of Windows. @@ -347,19 +344,19 @@ The information below applies to both managed WinMDs, which contain metadata and As far as the CLR is concerned, all WinMD files are modules. The CLR Profiling API therefore tells your Profiler DLL when WinMD files load and what their ModuleIDs are, in the same way as for other managed modules. -Your Profiler DLL can distinguish WinMD files from other modules by calling the [ICorProfilerInfo3::GetModuleInfo2](icorprofilerinfo3-getmoduleinfo2-method.md) method and inspecting the `pdwModuleFlags` output parameter for the [COR_PRF_MODULE_WINDOWS_RUNTIME](cor-prf-module-flags-enumeration.md) flag. (It’s set if and only if the ModuleID represents a WinMD.) +Your Profiler DLL can distinguish WinMD files from other modules by calling the [ICorProfilerInfo3::GetModuleInfo2](icorprofilerinfo3-getmoduleinfo2-method.md) method and inspecting the `pdwModuleFlags` output parameter for the [COR_PRF_MODULE_WINDOWS_RUNTIME](cor-prf-module-flags-enumeration.md) flag. (It's set if and only if the ModuleID represents a WinMD.) ### Reading metadata from WinMDs -WinMD files, like regular modules, contain metadata that can be read via the [Metadata APIs](../metadata/index.md). However, the CLR maps Windows Runtime types to .NET Framework types when it reads WinMD files so that developers who program in managed code and consume the WinMD file can have a more natural programming experience. For some examples of these mappings, see [.NET Framework Support for Windows Store Apps and Windows Runtime](/previous-versions/dotnet/framework/cross-platform/support-for-windows-store-apps-and-windows-runtime). +WinMD files, like regular modules, contain metadata that can be read via the [Metadata APIs](../../../core/unmanaged-api/metadata/index.md). However, the CLR maps Windows Runtime types to .NET Framework types when it reads WinMD files so that developers who program in managed code and consume the WinMD file can have a more natural programming experience. For some examples of these mappings, see [.NET Framework Support for Windows Store Apps and Windows Runtime](/previous-versions/dotnet/framework/cross-platform/support-for-windows-store-apps-and-windows-runtime). -So which view will your profiler get when it uses the metadata APIs: the raw Windows Runtime view, or the mapped .NET Framework view? The answer: it’s up to you. +So which view will your profiler get when it uses the metadata APIs: the raw Windows Runtime view, or the mapped .NET Framework view? The answer: it's up to you. -When you call the [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) method on a WinMD to obtain a metadata interface, such as [IMetaDataImport](../metadata/imetadataimport-interface.md), you can choose to set [ofNoTransform](../metadata/coropenflags-enumeration.md) in the `dwOpenFlags` parameter to turn off this mapping. Otherwise, by default, the mapping will be enabled. Typically, a profiler will keep the mapping enabled, so that the strings that the Profiler DLL obtains from the WinMD metadata (for example, names of types) will look familiar and natural to the profiler user. +When you call the [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) method on a WinMD to obtain a metadata interface, such as [IMetaDataImport](../../../core/unmanaged-api/metadata/imetadataimport-interface.md), you can choose to set [ofNoTransform](../../../core/unmanaged-api/metadata/coropenflags-enumeration.md) in the `dwOpenFlags` parameter to turn off this mapping. Otherwise, by default, the mapping will be enabled. Typically, a profiler will keep the mapping enabled, so that the strings that the Profiler DLL obtains from the WinMD metadata (for example, names of types) will look familiar and natural to the profiler user. ### Modifying metadata from WinMDs -Modifying metadata in WinMDs is not supported. If you call the [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) method for a WinMD file and specify [ofWrite](../metadata/coropenflags-enumeration.md) in the `dwOpenFlags` parameter or ask for a writeable metadata interface such as [IMetaDataEmit](../metadata/imetadataemit-interface.md), [GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) will fail. This is of particular importance to IL-rewriting profilers, which need to modify metadata to support their instrumentation (for example, to add AssemblyRefs or new methods). So you should check for [COR_PRF_MODULE_WINDOWS_RUNTIME](cor-prf-module-flags-enumeration.md) first (as discussed in the previous section) and refrain from asking for writeable metadata interfaces on such modules. +Modifying metadata in WinMDs is not supported. If you call the [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) method for a WinMD file and specify [ofWrite](../../../core/unmanaged-api/metadata/coropenflags-enumeration.md) in the `dwOpenFlags` parameter or ask for a writeable metadata interface such as [IMetaDataEmit](../../../core/unmanaged-api/metadata/imetadataemit-interface.md), [GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) will fail. This is of particular importance to IL-rewriting profilers, which need to modify metadata to support their instrumentation (for example, to add AssemblyRefs or new methods). So you should check for [COR_PRF_MODULE_WINDOWS_RUNTIME](cor-prf-module-flags-enumeration.md) first (as discussed in the previous section) and refrain from asking for writeable metadata interfaces on such modules. ### Resolving assembly references with WinMDs @@ -373,11 +370,11 @@ The garbage collector and managed heap are not fundamentally different in a Wind When doing memory profiling, your Profiler DLL typically creates a separate thread from which to call the [ForceGC Method](icorprofilerinfo-forcegc-method.md) method. This is nothing new. But what might be surprising is that the act of doing a garbage collection inside a Windows Store app may transform your thread into a managed thread (for example, a Profiling API ThreadID will be created for that thread). -To understand the consequences of this, it’s important to understand the differences between synchronous and asynchronous calls as defined by the CLR Profiling API. Note that this is very different from the concept of asynchronous calls in Windows Store apps. See the blog post [Why we have CORPROF_E_UNSUPPORTED_CALL_SEQUENCE](/archive/blogs/davbr/why-we-have-corprof_e_unsupported_call_sequence) for more information. +To understand the consequences of this, it's important to understand the differences between synchronous and asynchronous calls as defined by the CLR Profiling API. Note that this is very different from the concept of asynchronous calls in Windows Store apps. See the blog post [Why we have CORPROF_E_UNSUPPORTED_CALL_SEQUENCE](/archive/blogs/davbr/why-we-have-corprof_e_unsupported_call_sequence) for more information. -The relevant point is that calls made on threads created by your profiler are always considered synchronous, even if those calls are made from outside an implementation of one of your Profiler DLL’s [ICorProfilerCallback](icorprofilercallback-interface.md) methods. At least, that used to be the case. Now that the CLR has turned your profiler’s thread into a managed thread because of your call to [ForceGC Method](icorprofilerinfo-forcegc-method.md), that thread is no longer considered your profiler’s thread. As such, the CLR enforces a more stringent definition of what qualifies as synchronous for that thread—namely that a call must originate from inside one of your Profiler DLL’s [ICorProfilerCallback](icorprofilercallback-interface.md) methods to qualify as synchronous. +The relevant point is that calls made on threads created by your profiler are always considered synchronous, even if those calls are made from outside an implementation of one of your Profiler DLL's [ICorProfilerCallback](icorprofilercallback-interface.md) methods. At least, that used to be the case. Now that the CLR has turned your profiler's thread into a managed thread because of your call to [ForceGC Method](icorprofilerinfo-forcegc-method.md), that thread is no longer considered your profiler's thread. As such, the CLR enforces a more stringent definition of what qualifies as synchronous for that thread—namely that a call must originate from inside one of your Profiler DLL's [ICorProfilerCallback](icorprofilercallback-interface.md) methods to qualify as synchronous. -What does this mean in practice? Most [ICorProfilerInfo](icorprofilerinfo-interface.md) methods are only safe to be called synchronously, and will immediately fail otherwise. So if your Profiler DLL reuses your [ForceGC Method](icorprofilerinfo-forcegc-method.md) thread for other calls typically made on profiler-created threads (for example, to [RequestProfilerDetach](icorprofilerinfo3-requestprofilerdetach-method.md), [RequestReJIT](icorprofilerinfo4-requestrejit-method.md), or [RequestRevert](icorprofilerinfo4-requestrevert-method.md)), you’re going to have trouble. Even an asynchronous-safe function such as [DoStackSnapshot](icorprofilerinfo2-dostacksnapshot-method.md) has special rules when called from managed threads. (See the blog post [Profiler stack walking: Basics and beyond](/archive/blogs/davbr/profiler-stack-walking-basics-and-beyond) for more information.) +What does this mean in practice? Most [ICorProfilerInfo](icorprofilerinfo-interface.md) methods are only safe to be called synchronously, and will immediately fail otherwise. So if your Profiler DLL reuses your [ForceGC Method](icorprofilerinfo-forcegc-method.md) thread for other calls typically made on profiler-created threads (for example, to [RequestProfilerDetach](icorprofilerinfo3-requestprofilerdetach-method.md), [RequestReJIT](icorprofilerinfo4-requestrejit-method.md), or [RequestRevert](icorprofilerinfo4-requestrevert-method.md)), you're going to have trouble. Even an asynchronous-safe function such as [DoStackSnapshot](icorprofilerinfo2-dostacksnapshot-method.md) has special rules when called from managed threads. (See the blog post [Profiler stack walking: Basics and beyond](/archive/blogs/davbr/profiler-stack-walking-basics-and-beyond) for more information.) Therefore, we recommend that any thread your Profiler DLL creates to call [ForceGC Method](icorprofilerinfo-forcegc-method.md) should be used *only* for the purpose of triggering GCs and then responding to the GC callbacks. It should not call into the Profiling API to perform other tasks like stack sampling or detaching. @@ -385,11 +382,11 @@ Therefore, we recommend that any thread your Profiler DLL creates to call [Force Starting with .NET Framework 4.5, there is a new GC callback, [ConditionalWeakTableElementReferences](icorprofilercallback5-conditionalweaktableelementreferences-method.md), which gives the profiler more complete information about *dependent handles*. These handles effectively add a reference from a source object to a target object for the purpose of GC lifetime management. Dependent handles are nothing new, and developers who program in managed code have been able to create their own dependent handles by using the class even before Windows 8 and the .NET Framework 4.5. -However, managed XAML Windows Store apps now make heavy use of dependent handles. In particular, the CLR uses them to aid with managing reference cycles between managed objects and unmanaged Windows Runtime objects. This means that it’s more important now than ever for memory profilers to be informed of these dependent handles so that they can be visualized along with the rest of the edges in the heap graph. Your Profiler DLL should use [RootReferences2](icorprofilercallback2-rootreferences2-method.md), [ObjectReferences](icorprofilercallback-objectreferences-method.md), and [ConditionalWeakTableElementReferences](icorprofilercallback5-conditionalweaktableelementreferences-method.md) together to form a complete view of the heap graph. +However, managed XAML Windows Store apps now make heavy use of dependent handles. In particular, the CLR uses them to aid with managing reference cycles between managed objects and unmanaged Windows Runtime objects. This means that it's more important now than ever for memory profilers to be informed of these dependent handles so that they can be visualized along with the rest of the edges in the heap graph. Your Profiler DLL should use [RootReferences2](icorprofilercallback2-rootreferences2-method.md), [ObjectReferences](icorprofilercallback-objectreferences-method.md), and [ConditionalWeakTableElementReferences](icorprofilercallback5-conditionalweaktableelementreferences-method.md) together to form a complete view of the heap graph. ## Conclusion -It is possible to use the CLR Profiling API to analyze managed code running inside Windows Store apps. In fact, you can take an existing profiler that you’re developing and make some specific changes so that it can target Windows Store apps. Your Profiler UI should use the new APIs for activating the Windows Store app in debugging mode. Make sure that your Profiler DLL consumes only those APIs applicable for Windows Store apps. The communication mechanism between your Profiler DLL and Profiler UI should be written with the Windows Store app API restrictions in mind and with awareness of the restricted permissions in place for Windows Store apps. Your Profiler DLL should be aware of how the CLR treats WinMDs, and how the Garbage Collector’s behavior is different with respect to managed threads. +It is possible to use the CLR Profiling API to analyze managed code running inside Windows Store apps. In fact, you can take an existing profiler that you're developing and make some specific changes so that it can target Windows Store apps. Your Profiler UI should use the new APIs for activating the Windows Store app in debugging mode. Make sure that your Profiler DLL consumes only those APIs applicable for Windows Store apps. The communication mechanism between your Profiler DLL and Profiler UI should be written with the Windows Store app API restrictions in mind and with awareness of the restricted permissions in place for Windows Store apps. Your Profiler DLL should be aware of how the CLR treats WinMDs, and how the Garbage Collector's behavior is different with respect to managed threads. ## Resources @@ -397,7 +394,7 @@ It is possible to use the CLR Profiling API to analyze managed code running insi - [Profiling (Unmanaged API Reference)](index.md) -- [Metadata (Unmanaged API Reference)](../metadata/index.md) +- [Metadata (Unmanaged API Reference)](../../../core/unmanaged-api/metadata/index.md) **The CLR's interaction with the Windows Runtime** diff --git a/docs/framework/unmanaged-api/profiling/icorprofilercallback3-profilerdetachsucceeded-method.md b/docs/framework/unmanaged-api/profiling/icorprofilercallback3-profilerdetachsucceeded-method.md index fc5c114b5cb5b..ad1f501f723a8 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilercallback3-profilerdetachsucceeded-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilercallback3-profilerdetachsucceeded-method.md @@ -2,56 +2,56 @@ description: "Learn more about: ICorProfilerCallback3::ProfilerDetachSucceeded Method" title: "ICorProfilerCallback3::ProfilerDetachSucceeded Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorProfilerCallback3.ProfilerDetachSucceeded Method" -api_location: +api_location: - "mscorwks.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorProfilerCallback3::ProfilerDetachSucceeded" -helpviewer_keywords: +helpviewer_keywords: - "ProfilerDetachSucceeded method [.NET Framework profiling]" - "ICorProfilerCallback3::ProfilerDetachSucceeded method [.NET Framework profiling]" ms.assetid: 05164966-16ce-4cc9-a530-43a640c00711 -topic_type: +topic_type: - "apiref" --- # ICorProfilerCallback3::ProfilerDetachSucceeded Method -Notifies the profiler that the common language runtime (CLR) is about to unload the profiler DLL. - -## Syntax - -```cpp -HRESULT ProfilerDetachSucceeded(); -``` - -## Return Value - - The return value from this callback is ignored. - -## Remarks - - The `ProfilerDetachSucceeded` callback is issued after all threads have exited the profiler's code. When this method is called, the profiler should perform any last-minute tasks that are not appropriate for its destructor, such as notifying its UI or logging component. However, the profiler must not call functions on interfaces that are provided by the CLR during this callback (such as the [ICorProfilerInfo](icorprofilerinfo-interface.md) or `IMetaData*` interfaces). - - The CLR creates an entry in the Windows Application event log to indicate that the detach operation is successful. - - After the profiler returns from this callback, the CLR releases the profiler object and unloads the profiler DLL. Therefore, the profiler must not perform any actions that would cause execution to occur inside the profiler DLL after it returns from this callback. For example, it must not create threads or register timer callbacks. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorProf.idl, CorProf.h - - **Library:** CorGuids.lib - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Notifies the profiler that the common language runtime (CLR) is about to unload the profiler DLL. + +## Syntax + +```cpp +HRESULT ProfilerDetachSucceeded(); +``` + +## Return Value + + The return value from this callback is ignored. + +## Remarks + + The `ProfilerDetachSucceeded` callback is issued after all threads have exited the profiler's code. When this method is called, the profiler should perform any last-minute tasks that are not appropriate for its destructor, such as notifying its UI or logging component. However, the profiler must not call functions on interfaces that are provided by the CLR during this callback (such as the [ICorProfilerInfo](icorprofilerinfo-interface.md) or `IMetaData*` interfaces). + + The CLR creates an entry in the Windows Application event log to indicate that the detach operation is successful. + + After the profiler returns from this callback, the CLR releases the profiler object and unloads the profiler DLL. Therefore, the profiler must not perform any actions that would cause execution to occur inside the profiler DLL after it returns from this callback. For example, it must not create threads or register timer callbacks. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorProf.idl, CorProf.h + + **Library:** CorGuids.lib + + **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also -- [Metadata Interfaces](../metadata/metadata-interfaces.md) +- [Metadata Interfaces](../../../core/unmanaged-api/metadata/metadata-interfaces.md) - [ICorProfilerInfo3 Interface](icorprofilerinfo3-interface.md) - [Profiling Interfaces](profiling-interfaces.md) - [Profiling](index.md) diff --git a/docs/framework/unmanaged-api/profiling/icorprofilercallback6-getassemblyreferences-method.md b/docs/framework/unmanaged-api/profiling/icorprofilercallback6-getassemblyreferences-method.md index 8b721315c780a..8395aef5bc0c9 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilercallback6-getassemblyreferences-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilercallback6-getassemblyreferences-method.md @@ -2,65 +2,65 @@ description: "Learn more about: ICorProfilerCallback6::GetAssemblyReferences Method" title: "ICorProfilerCallback6::GetAssemblyReferences Method" ms.date: "03/30/2017" -dev_langs: +dev_langs: - "cpp" -api_name: +api_name: - "ICorProfilerCallback6.GetAssemblyReferences" -api_location: +api_location: - "mscorwks.dll" - "corprof.idl" -api_type: +api_type: - "COM" ms.assetid: 8b391afb-d79f-41bd-94ce-43ce62c6b5fc -topic_type: +topic_type: - "apiref" --- # ICorProfilerCallback6::GetAssemblyReferences Method -[Supported in the .NET Framework 4.5.2 and later versions] - - Notifies the profiler that an assembly is in a very early loading stage, when the common language runtime performs an assembly reference closure walk. - -## Syntax - +[Supported in the .NET Framework 4.5.2 and later versions] + + Notifies the profiler that an assembly is in a very early loading stage, when the common language runtime performs an assembly reference closure walk. + +## Syntax + ```cpp -HRESULT GetAssemblyReferences( [in, string] const WCHAR* wszAssemblyPath, - [in] ICorProfilerAssemblyReferenceProvider* pAsmRefProvider -); -``` - -## Parameters - - `wszAssemblyPath` - [in] The path and name of the assembly whose metadata will be modified. - - `pAsmRefProvider` - [in] A pointer to the address of an [ICorProfilerAssemblyReferenceProvider](icorprofilerassemblyreferenceprovider-interface.md) interface that specifies the assembly references to add. - -## Return Value - - Return values from this callback are ignored. - -## Remarks - - This callback is controlled by setting the [COR_PRF_HIGH_ADD_ASSEMBLY_REFERENCES](cor-prf-high-monitor-enumeration.md) event mask flag when calling the [ICorProfilerCallback5::SetEventMask2](icorprofilerinfo5-seteventmask2-method.md) method. If the profiler registers for the [ICorProfilerCallback6::GetAssemblyReferences](icorprofilercallback6-getassemblyreferences-method.md) callback method, the runtime passes the path and name of the assembly to be loaded, along with a pointer to an [ICorProfilerAssemblyReferenceProvider](icorprofilerassemblyreferenceprovider-interface.md) interface object to that method. The profiler can then call the [ICorProfilerAssemblyReferenceProvider::AddAssemblyReference](icorprofilerassemblyreferenceprovider-addassemblyreference-method.md) method with a `COR_PRF_ASSEMBLY_REFERENCE_INFO` object for each target assembly it plans to reference from the assembly specified in the `GetAssemblyReferences` callback. - - Use the `GetAssemblyReferences` callback only if the profiler has to modify an assembly's metadata to add assembly references. (But note that the actual modification of an assembly's metadata is done in the [ICorProfilerCallback::ModuleLoadFinished](icorprofilercallback-moduleloadfinished-method.md)callback method.) The profiler should implement the `GetAssemblyReferences` callback method to inform the common language runtime (CLR) that assembly references will be added when the module has been loaded. This helps ensure that assembly sharing decisions made by the CLR during this early stage remain valid although the profiler plans to modify the metadata assembly references later. This can avoid some instances in which profiler metadata modifications cause an `SECURITY_E_INCOMPATIBLE_SHARE` error. - - The profiler uses the [ICorProfilerAssemblyReferenceProvider](icorprofilerassemblyreferenceprovider-interface.md) object provided by this method to add assembly references to the CLR assembly reference closure walker. The [ICorProfilerAssemblyReferenceProvider](icorprofilerassemblyreferenceprovider-interface.md) object should be used only from within this callback. Calls to the [ICorProfilerAssemblyReferenceProvider::AddAssemblyReference](icorprofilerassemblyreferenceprovider-addassemblyreference-method.md) method from this callback don't result in modified metadata, but only in a modified assembly reference closure walk. The profiler will still have to use an [IMetaDataAssemblyEmit](../metadata/imetadataassemblyemit-interface.md) object to explicitly add assembly references from within the [ICorProfilerCallback::ModuleLoadFinished](icorprofilercallback-moduleloadfinished-method.md) callback for the referencing assembly, even if it implements the `GetAssemblyReferences` callback. - - The profiler should be prepared to receive duplicate calls to this callback for the same assembly, and should respond identically for each such duplicate call (by making the same set of [ICorProfilerAssemblyReferenceProvider::AddAssemblyReference](icorprofilerassemblyreferenceprovider-addassemblyreference-method.md) calls). - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorProf.idl, CorProf.h - - **Library:** CorGuids.lib - - **.NET Framework Versions:** [!INCLUDE[net_current_v452plus](../../../../includes/net-current-v452plus-md.md)] - +HRESULT GetAssemblyReferences( [in, string] const WCHAR* wszAssemblyPath, + [in] ICorProfilerAssemblyReferenceProvider* pAsmRefProvider +); +``` + +## Parameters + + `wszAssemblyPath` + [in] The path and name of the assembly whose metadata will be modified. + + `pAsmRefProvider` + [in] A pointer to the address of an [ICorProfilerAssemblyReferenceProvider](icorprofilerassemblyreferenceprovider-interface.md) interface that specifies the assembly references to add. + +## Return Value + + Return values from this callback are ignored. + +## Remarks + + This callback is controlled by setting the [COR_PRF_HIGH_ADD_ASSEMBLY_REFERENCES](cor-prf-high-monitor-enumeration.md) event mask flag when calling the [ICorProfilerCallback5::SetEventMask2](icorprofilerinfo5-seteventmask2-method.md) method. If the profiler registers for the [ICorProfilerCallback6::GetAssemblyReferences](icorprofilercallback6-getassemblyreferences-method.md) callback method, the runtime passes the path and name of the assembly to be loaded, along with a pointer to an [ICorProfilerAssemblyReferenceProvider](icorprofilerassemblyreferenceprovider-interface.md) interface object to that method. The profiler can then call the [ICorProfilerAssemblyReferenceProvider::AddAssemblyReference](icorprofilerassemblyreferenceprovider-addassemblyreference-method.md) method with a `COR_PRF_ASSEMBLY_REFERENCE_INFO` object for each target assembly it plans to reference from the assembly specified in the `GetAssemblyReferences` callback. + + Use the `GetAssemblyReferences` callback only if the profiler has to modify an assembly's metadata to add assembly references. (But note that the actual modification of an assembly's metadata is done in the [ICorProfilerCallback::ModuleLoadFinished](icorprofilercallback-moduleloadfinished-method.md)callback method.) The profiler should implement the `GetAssemblyReferences` callback method to inform the common language runtime (CLR) that assembly references will be added when the module has been loaded. This helps ensure that assembly sharing decisions made by the CLR during this early stage remain valid although the profiler plans to modify the metadata assembly references later. This can avoid some instances in which profiler metadata modifications cause an `SECURITY_E_INCOMPATIBLE_SHARE` error. + + The profiler uses the [ICorProfilerAssemblyReferenceProvider](icorprofilerassemblyreferenceprovider-interface.md) object provided by this method to add assembly references to the CLR assembly reference closure walker. The [ICorProfilerAssemblyReferenceProvider](icorprofilerassemblyreferenceprovider-interface.md) object should be used only from within this callback. Calls to the [ICorProfilerAssemblyReferenceProvider::AddAssemblyReference](icorprofilerassemblyreferenceprovider-addassemblyreference-method.md) method from this callback don't result in modified metadata, but only in a modified assembly reference closure walk. The profiler will still have to use an [IMetaDataAssemblyEmit](../../../core/unmanaged-api/metadata/imetadataassemblyemit-interface.md) object to explicitly add assembly references from within the [ICorProfilerCallback::ModuleLoadFinished](icorprofilercallback-moduleloadfinished-method.md) callback for the referencing assembly, even if it implements the `GetAssemblyReferences` callback. + + The profiler should be prepared to receive duplicate calls to this callback for the same assembly, and should respond identically for each such duplicate call (by making the same set of [ICorProfilerAssemblyReferenceProvider::AddAssemblyReference](icorprofilerassemblyreferenceprovider-addassemblyreference-method.md) calls). + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorProf.idl, CorProf.h + + **Library:** CorGuids.lib + + **.NET Framework Versions:** [!INCLUDE[net_current_v452plus](../../../../includes/net-current-v452plus-md.md)] + ## See also - [ICorProfilerCallback6 Interface](icorprofilercallback6-interface.md) diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo-getmodulemetadata-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo-getmodulemetadata-method.md index 54a93bb475006..65c8edc755723 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo-getmodulemetadata-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo-getmodulemetadata-method.md @@ -2,65 +2,65 @@ description: "Learn more about: ICorProfilerInfo::GetModuleMetaData Method" title: "ICorProfilerInfo::GetModuleMetaData Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorProfilerInfo.GetModuleMetaData" -api_location: +api_location: - "mscorwks.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorProfilerInfo::GetModuleMetaData" -helpviewer_keywords: +helpviewer_keywords: - "GetModuleMetaData method [.NET Framework profiling]" - "ICorProfilerInfo::GetModuleMetaData method [.NET Framework profiling]" ms.assetid: 7a439d92-348a-44dd-b60f-cad7cba56379 -topic_type: +topic_type: - "apiref" --- # ICorProfilerInfo::GetModuleMetaData Method -Gets a metadata interface instance that maps to the specified module. - -## Syntax - -```cpp -HRESULT GetModuleMetaData( - [in] ModuleID moduleId, - [in] DWORD dwOpenFlags, - [in] REFIID riid, - [out] IUnknown **ppOut); -``` - -## Parameters - - `moduleId` - [in] The ID of the module to which the interface instance will be mapped. - - `dwOpenFlags` - [in] A value of the [CorOpenFlags](../metadata/coropenflags-enumeration.md) enumeration that specifies the mode for opening manifest files. Only the `ofRead`, `ofWrite` and `ofNoTransform` bits are valid. - - `riid` - [in] The reference ID (GUID) of the metadata interface whose instance will be retrieved. See [Metadata Interfaces](../metadata/metadata-interfaces.md) for a list of the interfaces. - - `ppOut` - [out] A pointer to the address of the metadata interface instance. - -## Remarks - - You may ask for the metadata to be opened in read/write mode, but this will result in slower metadata execution of the program, because changes made to the metadata cannot be optimized as they were from the compiler. - - Some modules (such as resource modules) have no metadata. In those cases, `GetModuleMetaData` will return an HRESULT value of S_FALSE, and a null in *`ppOut`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorProf.idl, CorProf.h - - **Library:** CorGuids.lib - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets a metadata interface instance that maps to the specified module. + +## Syntax + +```cpp +HRESULT GetModuleMetaData( + [in] ModuleID moduleId, + [in] DWORD dwOpenFlags, + [in] REFIID riid, + [out] IUnknown **ppOut); +``` + +## Parameters + + `moduleId` + [in] The ID of the module to which the interface instance will be mapped. + + `dwOpenFlags` + [in] A value of the [CorOpenFlags](../../../core/unmanaged-api/metadata/coropenflags-enumeration.md) enumeration that specifies the mode for opening manifest files. Only the `ofRead`, `ofWrite` and `ofNoTransform` bits are valid. + + `riid` + [in] The reference ID (GUID) of the metadata interface whose instance will be retrieved. See [Metadata Interfaces](../../../core/unmanaged-api/metadata/metadata-interfaces.md) for a list of the interfaces. + + `ppOut` + [out] A pointer to the address of the metadata interface instance. + +## Remarks + + You may ask for the metadata to be opened in read/write mode, but this will result in slower metadata execution of the program, because changes made to the metadata cannot be optimized as they were from the compiler. + + Some modules (such as resource modules) have no metadata. In those cases, `GetModuleMetaData` will return an HRESULT value of S_FALSE, and a null in *`ppOut`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorProf.idl, CorProf.h + + **Library:** CorGuids.lib + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ICorProfilerInfo Interface](icorprofilerinfo-interface.md) diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclassidinfo2-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclassidinfo2-method.md index 8762ce85beaef..b5b93ab8000b6 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclassidinfo2-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclassidinfo2-method.md @@ -2,81 +2,81 @@ description: "Learn more about: ICorProfilerInfo2::GetClassIDInfo2 Method" title: "ICorProfilerInfo2::GetClassIDInfo2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorProfilerInfo2.GetClassIDInfo2" -api_location: +api_location: - "mscorwks.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorProfilerInfo2::GetClassIDInfo2" -helpviewer_keywords: +helpviewer_keywords: - "GetClassIDInfo2 method [.NET Framework profiling]" - "ICorProfilerInfo2::GetClassIDInfo2 method [.NET Framework profiling]" ms.assetid: 0141d582-d066-4d49-8d1f-ae82129a1960 -topic_type: +topic_type: - "apiref" --- # ICorProfilerInfo2::GetClassIDInfo2 Method -Gets the parent module and metadata token for the open generic definition of the specified class, the `ClassID` of its parent class, and the `ClassID` for each type argument, if present, of the class. - -## Syntax - -```cpp -HRESULT GetClassIDInfo2( - [in] ClassID classId, - [out] ModuleID *pModuleId, - [out] mdTypeDef *pTypeDefToken, - [out] ClassID *pParentClassId, - [in] ULONG32 cNumTypeArgs, - [out] ULONG32 *pcNumTypeArgs, - [out] ClassID typeArgs[]); -``` - -## Parameters - - `classId` - [in] The ID of the class for which information will be retrieved. - - `pModuleId` - [out] Pointer to the ID of the parent module for the open generic definition of the specified class. - - `pTypeDefToken` - [out] Pointer to the metadata token for the open generic definition of the specified class. - - `pParentClassId` - [out] Pointer to the ID of the parent class. - - `cNumTypeArgs` - [in] The size of the `typeArgs` array. - - `pcNumTypeArgs` - [out] Pointer to the total number of available elements. - - `typeArgs` - [out] An array of `ClassID` values, each of which represents the ID of a type argument of the class. When the method returns, `typeArgs` will contain some or all the available `ClassID` values. - -## Remarks - - The `GetClassIDInfo2` method is similar to the [ICorProfilerInfo::GetClassIDInfo](icorprofilerinfo-getclassidinfo-method.md) method, but `GetClassIDInfo2` obtains additional information about a generic type. - - The profiler code can call [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) to obtain a [metadata](../metadata/index.md) interface for a given module. The metadata token that is returned to the location referenced by `pTypeDefToken` can then be used to access the metadata for the class. - - After `GetClassIDInfo2` returns, you must verify that the `typeArgs` buffer was large enough to contain all the `ClassID` values. To do this, compare the value that `pcNumTypeArgs` points to with the value of the `cNumTypeArgs` parameter. If `pcNumTypeArgs` points to a value that is larger than `cNumTypeArgs`, allocate a larger `typeArgs` buffer, update `cNumTypeArgs` with the new, larger size, and call `GetClassIDInfo2` again. - - Alternatively, you can first call `GetClassIDInfo2` with a zero-length `typeArgs` buffer to obtain the correct buffer size. You can then set the `typeArgs` buffer size to the value returned in `pcNumTypeArgs` and call `GetClassIDInfo2` again. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorProf.idl, CorProf.h - - **Library:** CorGuids.lib - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets the parent module and metadata token for the open generic definition of the specified class, the `ClassID` of its parent class, and the `ClassID` for each type argument, if present, of the class. + +## Syntax + +```cpp +HRESULT GetClassIDInfo2( + [in] ClassID classId, + [out] ModuleID *pModuleId, + [out] mdTypeDef *pTypeDefToken, + [out] ClassID *pParentClassId, + [in] ULONG32 cNumTypeArgs, + [out] ULONG32 *pcNumTypeArgs, + [out] ClassID typeArgs[]); +``` + +## Parameters + + `classId` + [in] The ID of the class for which information will be retrieved. + + `pModuleId` + [out] Pointer to the ID of the parent module for the open generic definition of the specified class. + + `pTypeDefToken` + [out] Pointer to the metadata token for the open generic definition of the specified class. + + `pParentClassId` + [out] Pointer to the ID of the parent class. + + `cNumTypeArgs` + [in] The size of the `typeArgs` array. + + `pcNumTypeArgs` + [out] Pointer to the total number of available elements. + + `typeArgs` + [out] An array of `ClassID` values, each of which represents the ID of a type argument of the class. When the method returns, `typeArgs` will contain some or all the available `ClassID` values. + +## Remarks + + The `GetClassIDInfo2` method is similar to the [ICorProfilerInfo::GetClassIDInfo](icorprofilerinfo-getclassidinfo-method.md) method, but `GetClassIDInfo2` obtains additional information about a generic type. + + The profiler code can call [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) to obtain a [metadata](../../../core/unmanaged-api/metadata/index.md) interface for a given module. The metadata token that is returned to the location referenced by `pTypeDefToken` can then be used to access the metadata for the class. + + After `GetClassIDInfo2` returns, you must verify that the `typeArgs` buffer was large enough to contain all the `ClassID` values. To do this, compare the value that `pcNumTypeArgs` points to with the value of the `cNumTypeArgs` parameter. If `pcNumTypeArgs` points to a value that is larger than `cNumTypeArgs`, allocate a larger `typeArgs` buffer, update `cNumTypeArgs` with the new, larger size, and call `GetClassIDInfo2` again. + + Alternatively, you can first call `GetClassIDInfo2` with a zero-length `typeArgs` buffer to obtain the correct buffer size. You can then set the `typeArgs` buffer size to the value returned in `pcNumTypeArgs` and call `GetClassIDInfo2` again. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorProf.idl, CorProf.h + + **Library:** CorGuids.lib + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ICorProfilerInfo Interface](icorprofilerinfo-interface.md) diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclasslayout-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclasslayout-method.md index b5cd61614313e..d1a89b446dd54 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclasslayout-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclasslayout-method.md @@ -2,73 +2,73 @@ description: "Learn more about: ICorProfilerInfo2::GetClassLayout Method" title: "ICorProfilerInfo2::GetClassLayout Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorProfilerInfo2.GetClassLayout" -api_location: +api_location: - "mscorwks.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorProfilerInfo2::GetClassLayout" -helpviewer_keywords: +helpviewer_keywords: - "ICorProfilerInfo2::GetClassLayout method [.NET Framework profiling]" - "GetClassLayout method, ICorProfilerInfo2 interface [.NET Framework profiling]" ms.assetid: a3a36987-5666-4e2f-95b5-d0cb246502ec -topic_type: +topic_type: - "apiref" --- # ICorProfilerInfo2::GetClassLayout Method -Gets information about the layout, in memory, of the fields defined by the specified class. That is, this method gets the offsets of the class's fields. - -## Syntax - -```cpp -HRESULT GetClassLayout( - [in] ClassID classID, - [in, out] COR_FIELD_OFFSET rFieldOffset[], - [in] ULONG cFieldOffset, - [out] ULONG *pcFieldOffset, - [out] ULONG *pulClassSize); -``` - -## Parameters - - `classID` - [in] The ID of the class for which the layout will be retrieved. - - `rFieldOffset` - [in, out] An array of [COR_FIELD_OFFSET](../metadata/cor-field-offset-structure.md) structures, each of which contains the tokens and offsets of the class's fields. - - `cFieldOffset` - [in] The size of the `rFieldOffset` array. - - `pcFieldOffset` - [out] A pointer to the total number of available elements. If `cFieldOffset` is 0, this value indicates the number of elements needed. - - `pulClassSize` - [out] A pointer to a location that contains the size, in bytes, of the class. - -## Remarks - - The `GetClassLayout` method returns only the fields defined by the class itself. If the class's parent class has defined fields as well, the profiler must call `GetClassLayout` on the parent class to obtain those fields. - - If you use `GetClassLayout` with string classes, the method will fail with error code E_INVALIDARG. Use [ICorProfilerInfo2::GetStringLayout](icorprofilerinfo2-getstringlayout-method.md) to get information about the layout of a string. `GetClassLayout` will also fail when called with an array class. - - After `GetClassLayout` returns, you must verify that the `rFieldOffset` buffer was large enough to contain all the available `COR_FIELD_OFFSET` structures. To do this, compare the value that `pcFieldOffset` points to with the size of `rFieldOffset` divided by the size of a `COR_FIELD_OFFSET` structure. If `rFieldOffset` is not large enough, allocate a larger `rFieldOffset` buffer, update `cFieldOffset` with the new, larger size, and call `GetClassLayout` again. - - Alternatively, you can first call `GetClassLayout` with a zero-length `rFieldOffset` buffer to obtain the correct buffer size. You can then set the buffer size to the value returned in `pcFieldOffset` and call `GetClassLayout` again. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorProf.idl, CorProf.h - - **Library:** CorGuids.lib - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets information about the layout, in memory, of the fields defined by the specified class. That is, this method gets the offsets of the class's fields. + +## Syntax + +```cpp +HRESULT GetClassLayout( + [in] ClassID classID, + [in, out] COR_FIELD_OFFSET rFieldOffset[], + [in] ULONG cFieldOffset, + [out] ULONG *pcFieldOffset, + [out] ULONG *pulClassSize); +``` + +## Parameters + + `classID` + [in] The ID of the class for which the layout will be retrieved. + + `rFieldOffset` + [in, out] An array of [COR_FIELD_OFFSET](../../../core/unmanaged-api/metadata/cor-field-offset-structure.md) structures, each of which contains the tokens and offsets of the class's fields. + + `cFieldOffset` + [in] The size of the `rFieldOffset` array. + + `pcFieldOffset` + [out] A pointer to the total number of available elements. If `cFieldOffset` is 0, this value indicates the number of elements needed. + + `pulClassSize` + [out] A pointer to a location that contains the size, in bytes, of the class. + +## Remarks + + The `GetClassLayout` method returns only the fields defined by the class itself. If the class's parent class has defined fields as well, the profiler must call `GetClassLayout` on the parent class to obtain those fields. + + If you use `GetClassLayout` with string classes, the method will fail with error code E_INVALIDARG. Use [ICorProfilerInfo2::GetStringLayout](icorprofilerinfo2-getstringlayout-method.md) to get information about the layout of a string. `GetClassLayout` will also fail when called with an array class. + + After `GetClassLayout` returns, you must verify that the `rFieldOffset` buffer was large enough to contain all the available `COR_FIELD_OFFSET` structures. To do this, compare the value that `pcFieldOffset` points to with the size of `rFieldOffset` divided by the size of a `COR_FIELD_OFFSET` structure. If `rFieldOffset` is not large enough, allocate a larger `rFieldOffset` buffer, update `cFieldOffset` with the new, larger size, and call `GetClassLayout` again. + + Alternatively, you can first call `GetClassLayout` with a zero-length `rFieldOffset` buffer to obtain the correct buffer size. You can then set the buffer size to the value returned in `pcFieldOffset` and call `GetClassLayout` again. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorProf.idl, CorProf.h + + **Library:** CorGuids.lib + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ICorProfilerInfo Interface](icorprofilerinfo-interface.md) diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md index 3fac43a54f262..93ce7274487d2 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md @@ -2,91 +2,91 @@ description: "Learn more about: ICorProfilerInfo2::GetFunctionInfo2 Method" title: "ICorProfilerInfo2::GetFunctionInfo2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorProfilerInfo2.GetFunctionInfo2" -api_location: +api_location: - "mscorwks.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorProfilerInfo2::GetFunctionInfo2" -helpviewer_keywords: +helpviewer_keywords: - "GetFunctionInfo2 method [.NET Framework profiling]" - "ICorProfilerInfo2::GetFunctionInfo2 method [.NET Framework profiling]" ms.assetid: 0aa60f24-8bbd-4c83-83c5-86ad191b1d82 -topic_type: +topic_type: - "apiref" --- # ICorProfilerInfo2::GetFunctionInfo2 Method -Gets the parent class, the metadata token, and the `ClassID` of each type argument, if present, of a function. - -## Syntax - -```cpp -HRESULT GetFunctionInfo2( - [in] FunctionID funcId, - [in] COR_PRF_FRAME_INFO frameInfo, - [out] ClassID *pClassId, - [out] ModuleID *pModuleId, - [out] mdToken *pToken, - [in] ULONG32 cTypeArgs, - [out] ULONG32 *pcTypeArgs, - [out] ClassID typeArgs[]); -``` - -## Parameters - - `funcId` - [in] The ID of the function for which to get the parent class and other information. - - `frameInfo` - [in] A `COR_PRF_FRAME_INFO` value that points to information about a stack frame. - - `pClassId` - [out] A pointer to the parent class of the function. - - `pModuleId` - [out] A pointer to the module in which the function's parent class is defined. - - `pToken` - [out] A pointer to the metadata token for the function. - - `cTypeArgs` - [in] The size of the `typeArgs` array. - - `pcTypeArgs` - [out] A pointer to the total number of `ClassID` values. - - `typeArgs` - [out] An array of `ClassID` values, each of which is the ID of a type argument of the function. When the method returns, `typeArgs` will contain some or all of the `ClassID` values. - -## Remarks - - The profiler code can call [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) to obtain a [metadata](../metadata/index.md) interface for a given module. The metadata token that is returned to the location referenced by `pToken` can then be used to access the metadata for the function. - - The class ID and type arguments that are returned through the `pClassId` and `typeArgs` parameters depend on the value that is passed in the `frameInfo` parameter, as shown in the following table. - -|Value of the `frameInfo` parameter|Result| -|----------------------------------------|------------| -|A `COR_PRF_FRAME_INFO` value that was obtained from a `FunctionEnter2` callback|The `ClassID`, returned in the location referenced by `pClassId`, and all type arguments, returned in the `typeArgs` array, will be exact.| -|A `COR_PRF_FRAME_INFO` that was obtained from a source other than a `FunctionEnter2` callback|The exact `ClassID` and type arguments cannot be determined. That is, the `ClassID` might be null and some type arguments might come back as .| -|Zero|The exact `ClassID` and type arguments cannot be determined. That is, the `ClassID` might be null and some type arguments might come back as .| - - After `GetFunctionInfo2` returns, you must verify that the `typeArgs` buffer was large enough to contain all the `ClassID` values. To do this, compare the value that `pcTypeArgs` points to with the value of the `cTypeArgs` parameter. If `pcTypeArgs` points to a value that is larger than `cTypeArgs` divided by the size of a `ClassID` value, allocate a larger `pcTypeArgs` buffer, update `cTypeArgs` with the new, larger size, and call `GetFunctionInfo2` again. - - Alternatively, you can first call `GetFunctionInfo2` with a zero-length `pcTypeArgs` buffer to obtain the correct buffer size. You can then set the buffer size to the value returned in `pcTypeArgs` divided by the size of a `ClassID` value, and call `GetFunctionInfo2` again. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorProf.idl, CorProf.h - - **Library:** CorGuids.lib - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets the parent class, the metadata token, and the `ClassID` of each type argument, if present, of a function. + +## Syntax + +```cpp +HRESULT GetFunctionInfo2( + [in] FunctionID funcId, + [in] COR_PRF_FRAME_INFO frameInfo, + [out] ClassID *pClassId, + [out] ModuleID *pModuleId, + [out] mdToken *pToken, + [in] ULONG32 cTypeArgs, + [out] ULONG32 *pcTypeArgs, + [out] ClassID typeArgs[]); +``` + +## Parameters + + `funcId` + [in] The ID of the function for which to get the parent class and other information. + + `frameInfo` + [in] A `COR_PRF_FRAME_INFO` value that points to information about a stack frame. + + `pClassId` + [out] A pointer to the parent class of the function. + + `pModuleId` + [out] A pointer to the module in which the function's parent class is defined. + + `pToken` + [out] A pointer to the metadata token for the function. + + `cTypeArgs` + [in] The size of the `typeArgs` array. + + `pcTypeArgs` + [out] A pointer to the total number of `ClassID` values. + + `typeArgs` + [out] An array of `ClassID` values, each of which is the ID of a type argument of the function. When the method returns, `typeArgs` will contain some or all of the `ClassID` values. + +## Remarks + + The profiler code can call [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) to obtain a [metadata](../../../core/unmanaged-api/metadata/index.md) interface for a given module. The metadata token that is returned to the location referenced by `pToken` can then be used to access the metadata for the function. + + The class ID and type arguments that are returned through the `pClassId` and `typeArgs` parameters depend on the value that is passed in the `frameInfo` parameter, as shown in the following table. + +|Value of the `frameInfo` parameter|Result| +|----------------------------------------|------------| +|A `COR_PRF_FRAME_INFO` value that was obtained from a `FunctionEnter2` callback|The `ClassID`, returned in the location referenced by `pClassId`, and all type arguments, returned in the `typeArgs` array, will be exact.| +|A `COR_PRF_FRAME_INFO` that was obtained from a source other than a `FunctionEnter2` callback|The exact `ClassID` and type arguments cannot be determined. That is, the `ClassID` might be null and some type arguments might come back as .| +|Zero|The exact `ClassID` and type arguments cannot be determined. That is, the `ClassID` might be null and some type arguments might come back as .| + + After `GetFunctionInfo2` returns, you must verify that the `typeArgs` buffer was large enough to contain all the `ClassID` values. To do this, compare the value that `pcTypeArgs` points to with the value of the `cTypeArgs` parameter. If `pcTypeArgs` points to a value that is larger than `cTypeArgs` divided by the size of a `ClassID` value, allocate a larger `pcTypeArgs` buffer, update `cTypeArgs` with the new, larger size, and call `GetFunctionInfo2` again. + + Alternatively, you can first call `GetFunctionInfo2` with a zero-length `pcTypeArgs` buffer to obtain the correct buffer size. You can then set the buffer size to the value returned in `pcTypeArgs` divided by the size of a `ClassID` value, and call `GetFunctionInfo2` again. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorProf.idl, CorProf.h + + **Library:** CorGuids.lib + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ICorProfilerInfo Interface](icorprofilerinfo-interface.md) diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getmoduleinfo2-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getmoduleinfo2-method.md index 57700595f09eb..03f16f6bd5728 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getmoduleinfo2-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getmoduleinfo2-method.md @@ -2,82 +2,82 @@ description: "Learn more about: ICorProfilerInfo3::GetModuleInfo2 Method" title: "ICorProfilerInfo3::GetModuleInfo2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorProfilerInfo3.GetModuleInfo2" -api_location: +api_location: - "mscorwks.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorProfilerInfo3::GetModuleInfo2" -helpviewer_keywords: +helpviewer_keywords: - "ICorProfilerInfo3::GetModuleInfo2 method [.NET Framework profiling]" - "GetModuleInfo2 method [.NET Framework profiling]" ms.assetid: f1f6b8f3-dcfc-49e8-be76-ea50ea90d5a7 -topic_type: +topic_type: - "apiref" --- # ICorProfilerInfo3::GetModuleInfo2 Method -Given a module ID, returns the file name of the module, the ID of the module's parent assembly, and a bitmask that describes the properties of the module. - -## Syntax - -```cpp -HRESULT GetModuleInfo2( - [in] ModuleID moduleId, - [out] LPCBYTE *ppBaseLoadAddress, - [in] ULONG cchName, - [out] ULONG *pcchName, - [out, annotation("__out_ecount_part(cchName, *pcchName)")] - WCHAR szName[] , - [out] AssemblyID *pAssemblyId); - [out] DWORD *pdwModuleFlags); -``` - -## Parameters - - `moduleId` - [in] The ID of the module for which information will be retrieved. - - `ppBaseLoadAddress` - [out] The base address at which the module is loaded. - - `cchName` - [in] The length, in characters, of the `szName` return buffer. - - `pcchName` - [out] A pointer to the total character length of the module's file name that is returned. - - `szName` - [out] A caller-provided wide character buffer. When the method returns, this buffer contains the file name of the module. - - `pAssemblyId` - [out] A pointer to the ID of the module's parent assembly. - - `pdwModuleFlags` - [out] A bitmask of values from the [COR_PRF_MODULE_FLAGS](cor-prf-module-flags-enumeration.md) enumeration that specify the properties of the module. - -## Remarks - - For dynamic modules, the `szName` parameter is the metadata name of the module, and the base address is 0 (zero). The metadata name is the value in the Name column from the Module table inside metadata. This is also exposed as the property to managed code, and as the `szName` parameter of the [IMetaDataImport::GetScopeProps](../metadata/imetadataimport-getscopeprops-method.md) method to unmanaged metadata client code. - - Although the `GetModuleInfo2` method may be called as soon as the module's ID exists, the ID of the parent assembly will not be available until the profiler receives the [ICorProfilerCallback::ModuleAttachedToAssembly](icorprofilercallback-moduleattachedtoassembly-method.md) callback. - - When `GetModuleInfo2` returns, you must verify that the `szName` buffer was large enough to contain the full file name of the module. To do this, compare the value that `pcchName` points to with the value of the `cchName` parameter. If `pcchName` points to a value that is larger than `cchName`, allocate a larger `szName` buffer, update `cchName` with the new, larger size, and call `GetModuleInfo2` again. - - Alternatively, you can first call `GetModuleInfo2` with a zero-length `szName` buffer to obtain the correct buffer size. You can then set the buffer size to the value returned in `pcchName` and call `GetModuleInfo2` again. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorProf.idl, CorProf.h - - **Library:** CorGuids.lib - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Given a module ID, returns the file name of the module, the ID of the module's parent assembly, and a bitmask that describes the properties of the module. + +## Syntax + +```cpp +HRESULT GetModuleInfo2( + [in] ModuleID moduleId, + [out] LPCBYTE *ppBaseLoadAddress, + [in] ULONG cchName, + [out] ULONG *pcchName, + [out, annotation("__out_ecount_part(cchName, *pcchName)")] + WCHAR szName[] , + [out] AssemblyID *pAssemblyId); + [out] DWORD *pdwModuleFlags); +``` + +## Parameters + + `moduleId` + [in] The ID of the module for which information will be retrieved. + + `ppBaseLoadAddress` + [out] The base address at which the module is loaded. + + `cchName` + [in] The length, in characters, of the `szName` return buffer. + + `pcchName` + [out] A pointer to the total character length of the module's file name that is returned. + + `szName` + [out] A caller-provided wide character buffer. When the method returns, this buffer contains the file name of the module. + + `pAssemblyId` + [out] A pointer to the ID of the module's parent assembly. + + `pdwModuleFlags` + [out] A bitmask of values from the [COR_PRF_MODULE_FLAGS](cor-prf-module-flags-enumeration.md) enumeration that specify the properties of the module. + +## Remarks + + For dynamic modules, the `szName` parameter is the metadata name of the module, and the base address is 0 (zero). The metadata name is the value in the Name column from the Module table inside metadata. This is also exposed as the property to managed code, and as the `szName` parameter of the [IMetaDataImport::GetScopeProps](../../../core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md) method to unmanaged metadata client code. + + Although the `GetModuleInfo2` method may be called as soon as the module's ID exists, the ID of the parent assembly will not be available until the profiler receives the [ICorProfilerCallback::ModuleAttachedToAssembly](icorprofilercallback-moduleattachedtoassembly-method.md) callback. + + When `GetModuleInfo2` returns, you must verify that the `szName` buffer was large enough to contain the full file name of the module. To do this, compare the value that `pcchName` points to with the value of the `cchName` parameter. If `pcchName` points to a value that is larger than `cchName`, allocate a larger `szName` buffer, update `cchName` with the new, larger size, and call `GetModuleInfo2` again. + + Alternatively, you can first call `GetModuleInfo2` with a zero-length `szName` buffer to obtain the correct buffer size. You can then set the buffer size to the value returned in `pcchName` and call `GetModuleInfo2` again. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorProf.idl, CorProf.h + + **Library:** CorGuids.lib + + **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICorProfilerInfo Interface](icorprofilerinfo-interface.md) diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo7-applymetadata-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo7-applymetadata-method.md index baa39d8101e76..b567068b80838 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo7-applymetadata-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo7-applymetadata-method.md @@ -2,69 +2,69 @@ description: "Learn more about: ICorProfilerInfo7::ApplyMetaData Method" title: "ICorProfilerInfo7::ApplyMetaData Method" ms.date: "02/15/2019" -dev_langs: +dev_langs: - "cpp" -api_name: +api_name: - "ICorProfilerInfo7.ApplyMetaData" -api_location: +api_location: - "mscorwks.dll" -api_type: +api_type: - "COM" ms.assetid: a1bfb649-4584-4d35-b3e6-8fe59b53992a --- # ICorProfilerInfo7::ApplyMetaData Method -[Supported in the .NET Framework 4.6.1 and later versions] - - Applies the metadata newly defined by the `IMetadataEmit::Define*` methods to a specified module. - -## Syntax - +[Supported in the .NET Framework 4.6.1 and later versions] + + Applies the metadata newly defined by the `IMetadataEmit::Define*` methods to a specified module. + +## Syntax + ```cpp -HRESULT ApplyMetaData( - [in] ModuleID moduleID -); -``` - -## Parameters - - `moduleID` - [in] The identifier of the module whose metadata was changed. - -## Remarks - - If metadata changes are made after the [ModuleLoadFinished](icorprofilercallback-moduleloadfinished-method.md) callback, you must call this method before using the new metadata. - - `ApplyMetaData` only supports adding the following types of metadata: - -- `AssemblyRef` records, which you create by calling the [IMetaDataAssemblyEmit::DefineAssemblyRef](../metadata/imetadataassemblyemit-defineassemblyref-method.md). method. - -- `TypeRef` records, which you create by calling the [IMetaDataEmit::DefineTypeRefByName](../metadata/imetadataemit-definetyperefbyname-method.md) method. - -- `TypeSpec` records, which you create by calling the [IMetaDataEmit::GetTokenFromTypeSpec](../metadata/imetadataemit-gettokenfromtypespec-method.md) method. - -- `MemberRef` records, which you create by calling the [IMetaDataEmit::DefineMemberRef](../metadata/imetadataemit-definememberref-method.md) method. - -- `MemberSpec` records, which you create by calling the [IMetaDataEmit2::DefineMethodSpec](../metadata/imetadataemit2-definemethodspec-method.md) method. - -- `UserString` records, which you create by calling the [IMetaDataEmit::DefineUserString](../metadata/imetadataemit-defineuserstring-method.md) method. +HRESULT ApplyMetaData( + [in] ModuleID moduleID +); +``` + +## Parameters + + `moduleID` + [in] The identifier of the module whose metadata was changed. + +## Remarks + + If metadata changes are made after the [ModuleLoadFinished](icorprofilercallback-moduleloadfinished-method.md) callback, you must call this method before using the new metadata. + + `ApplyMetaData` only supports adding the following types of metadata: + +- `AssemblyRef` records, which you create by calling the [IMetaDataAssemblyEmit::DefineAssemblyRef](../../../core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md). method. + +- `TypeRef` records, which you create by calling the [IMetaDataEmit::DefineTypeRefByName](../../../core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md) method. + +- `TypeSpec` records, which you create by calling the [IMetaDataEmit::GetTokenFromTypeSpec](../../../core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md) method. + +- `MemberRef` records, which you create by calling the [IMetaDataEmit::DefineMemberRef](../../../core/unmanaged-api/metadata/imetadataemit-definememberref-method.md) method. + +- `MemberSpec` records, which you create by calling the [IMetaDataEmit2::DefineMethodSpec](../../../core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md) method. + +- `UserString` records, which you create by calling the [IMetaDataEmit::DefineUserString](../../../core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md) method. Starting with .NET Core 3.0, `ApplyMetaData` also supports the following types: -- `TypeDef` records, which you create by calling the [IMetaDataEmit::DefineTypeDef](../metadata/imetadataemit-definetypedef-method.md) method. +- `TypeDef` records, which you create by calling the [IMetaDataEmit::DefineTypeDef](../../../core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md) method. + +- `MethodDef` records, which you create by calling the [IMetaDataEmit::DefineMethod](../../../core/unmanaged-api/metadata/imetadataemit-definemethod-method.md) method. However, adding virtual methods to an existing type is not supported. Virtual methods must be added before the [ModuleLoadFinished](icorprofilercallback-moduleloadfinished-method.md) callback. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** CorProf.idl, CorProf.h -- `MethodDef` records, which you create by calling the [IMetaDataEmit::DefineMethod](../metadata/imetadataemit-definemethod-method.md) method. However, adding virtual methods to an existing type is not supported. Virtual methods must be added before the [ModuleLoadFinished](icorprofilercallback-moduleloadfinished-method.md) callback. + **Library:** CorGuids.lib -## Requirements + **.NET Framework Versions:** [!INCLUDE[net_current_v461plus](../../../../includes/net-current-v461plus-md.md)] - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** CorProf.idl, CorProf.h - - **Library:** CorGuids.lib - - **.NET Framework Versions:** [!INCLUDE[net_current_v461plus](../../../../includes/net-current-v461plus-md.md)] - ## See also - [ICorProfilerInfo7 Interface](icorprofilerinfo7-interface.md) diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo8-getdynamicfunctioninfo-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo8-getdynamicfunctioninfo-method.md index 4e59c781347cb..7532bffcac38d 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo8-getdynamicfunctioninfo-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo8-getdynamicfunctioninfo-method.md @@ -54,7 +54,7 @@ HRESULT GetDynamicFunctionInfo( [in] FunctionID functionId, ## Remarks -Certain methods like IL Stubs or LCG do not have associated metadata that can be retrieved using the [IMetaDataImport](../metadata/imetadataimport-interface.md) and [IMetaDataImport2](../metadata/imetadataimport2-interface.md) APIs. Such methods can be encountered by profilers through instruction pointers or by listening to [ICorProfilerCallback8::DynamicMethodJITCompilationStarted](icorprofilercallback8-dynamicmethodjitcompilationstarted-method.md). +Certain methods like IL Stubs or LCG do not have associated metadata that can be retrieved using the [IMetaDataImport](../../../core/unmanaged-api/metadata/imetadataimport-interface.md) and [IMetaDataImport2](../../../core/unmanaged-api/metadata/imetadataimport2-interface.md) APIs. Such methods can be encountered by profilers through instruction pointers or by listening to [ICorProfilerCallback8::DynamicMethodJITCompilationStarted](icorprofilercallback8-dynamicmethodjitcompilationstarted-method.md). This API can be used to retrieve information about dynamic methods, including a friendly name, if available. diff --git a/docs/framework/unmanaged-api/toc.yml b/docs/framework/unmanaged-api/toc.yml index cd603b8791981..c45e583d04a8e 100644 --- a/docs/framework/unmanaged-api/toc.yml +++ b/docs/framework/unmanaged-api/toc.yml @@ -1,5 +1,5 @@ items: -- name: Unmanaged API reference +- name: .NET Framework unmanaged API reference href: index.md - name: Common data types href: common-data-types-unmanaged-api-reference.md @@ -8,7 +8,7 @@ items: - name: Authenticode items: - name: Overview - href: index.md + href: authenticode/index.md displayName: authenticode - name: _AxlGetIssuerPublicKeyHash function href: authenticode/axlgetissuerpublickeyhash-function.md @@ -38,8 +38,6 @@ items: href: fusion/ - name: Hosting href: hosting/ -- name: Metadata - href: metadata/ - name: Profiling href: profiling/ - name: Strong naming diff --git a/docs/fundamentals/reflection/emitting-dynamic-methods-and-assemblies.md b/docs/fundamentals/reflection/emitting-dynamic-methods-and-assemblies.md index 21a308bce4d5a..09b9755af5188 100644 --- a/docs/fundamentals/reflection/emitting-dynamic-methods-and-assemblies.md +++ b/docs/fundamentals/reflection/emitting-dynamic-methods-and-assemblies.md @@ -22,7 +22,7 @@ Reflection emit provides the following capabilities: - Define types in modules at run time, create instances of these types, and invoke their methods. - Define symbolic information for defined modules that can be used by tools such as debuggers and code profilers. -In addition to the managed types in the namespace, there are unmanaged metadata interfaces that are described in the [Metadata Interfaces](../../framework/unmanaged-api/metadata/metadata-interfaces.md) reference documentation. Managed reflection emit provides stronger semantic error checking and a higher level of abstraction of the metadata than the unmanaged metadata interfaces. +In addition to the managed types in the namespace, there are unmanaged metadata interfaces that are described in the [Metadata Interfaces](../../core/unmanaged-api/metadata/metadata-interfaces.md) reference documentation. Managed reflection emit provides stronger semantic error checking and a higher level of abstraction of the metadata than the unmanaged metadata interfaces. Another useful resource for working with metadata and CIL is the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics" and "Partition III: CIL Instruction Set". The documentation is available online at the [Ecma Web site](https://www.ecma-international.org/publications-and-standards/standards/ecma-335/). diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index e78549125f464..0668174c533db 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -571,6 +571,8 @@ items: href: ../../core/diagnostics/debug-stackoverflow.md - name: Unmanaged API reference items: + - name: Overview + href: ../../core/unmanaged-api/index.md - name: Debugging items: - name: Overview @@ -635,6 +637,596 @@ items: items: - name: PSTARTUP_CALLBACK function pointer href: ../../core/unmanaged-api/debugging/pstartup_callback-function-pointer.md + - name: Metadata + items: + - name: Overview + href: ../../core/unmanaged-api/metadata/index.md + - name: Interfaces + href: ../../core/unmanaged-api/metadata/metadata-interfaces.md + items: + - name: ICeeGen interface + href: ../../core/unmanaged-api/metadata/iceegen-interface.md + items: + - name: AddSectionReloc Method + href: ../../core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md + - name: AllocateMethodBuffer Method + href: ../../core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md + - name: ComputePointer Method + href: ../../core/unmanaged-api/metadata/iceegen-computepointer-method.md + - name: EmitString Method + href: ../../core/unmanaged-api/metadata/iceegen-emitstring-method.md + - name: GenerateCeeFile Method + href: ../../core/unmanaged-api/metadata/iceegen-generateceefile-method.md + - name: GenerateCeeMemoryImage Method + href: ../../core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md + - name: GetIlSection Method + href: ../../core/unmanaged-api/metadata/iceegen-getilsection-method.md + - name: GetIMapTokenIface Method + href: ../../core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md + - name: GetMethodBuffer Method + href: ../../core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md + - name: GetSectionBlock Method + href: ../../core/unmanaged-api/metadata/iceegen-getsectionblock-method.md + - name: GetSectionCreate Method + href: ../../core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md + - name: GetSectionDataLen Method + href: ../../core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md + - name: GetString Method + href: ../../core/unmanaged-api/metadata/iceegen-getstring-method.md + - name: GetStringSection Method + href: ../../core/unmanaged-api/metadata/iceegen-getstringsection-method.md + - name: TruncateSection Method + href: ../../core/unmanaged-api/metadata/iceegen-truncatesection-method.md + - name: IHostFilter interface + href: ../../core/unmanaged-api/metadata/ihostfilter-interface.md + items: + - name: MarkToken Method + href: ../../core/unmanaged-api/metadata/ihostfilter-marktoken-method.md + - name: IMapToken interface + href: ../../core/unmanaged-api/metadata/imaptoken-interface.md + items: + - name: Map Method + href: ../../core/unmanaged-api/metadata/imaptoken-map-method.md + - name: IMetaDataAssemblyEmit interface + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-interface.md + items: + - name: DefineAssembly Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md + - name: DefineAssemblyRef Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md + - name: DefineExportedType Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md + - name: DefineFile Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md + - name: DefineManifestResource Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md + - name: SetAssemblyProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md + - name: SetAssemblyRefProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md + - name: SetExportedTypeProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md + - name: SetFileProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md + - name: SetManifestResourceProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md + - name: IMetaDataAssemblyImport interface + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md + items: + - name: CloseEnum Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md + - name: EnumAssemblyRefs Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md + - name: EnumExportedTypes Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md + - name: EnumFiles Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md + - name: EnumManifestResources Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md + - name: FindAssembliesByName Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md + - name: FindExportedTypeByName Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md + - name: FindManifestResourceByName Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md + - name: GetAssemblyFromScope Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md + - name: GetAssemblyProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md + - name: GetAssemblyRefProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md + - name: GetExportedTypeProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md + - name: GetFileProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md + - name: GetManifestResourceProps Method + href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md + - name: IMetaDataConverter interface + href: ../../core/unmanaged-api/metadata/imetadataconverter-interface.md + items: + - name: GetMetaDataFromTypeInfo Method + href: ../../core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md + - name: GetMetaDataFromTypeLib Method + href: ../../core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md + - name: GetTypeLibFromMetaData Method + href: ../../core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md + - name: IMetaDataDispenser interface + href: ../../core/unmanaged-api/metadata/imetadatadispenser-interface.md + items: + - name: DefineScope Method + href: ../../core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md + - name: OpenScope Method + href: ../../core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md + - name: OpenScopeOnMemory Method + href: ../../core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md + - name: IMetaDataDispenserEx interface + href: ../../core/unmanaged-api/metadata/imetadatadispenserex-interface.md + items: + - name: FindAssembly Method + href: ../../core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md + - name: FindAssemblyModule Method + href: ../../core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md + - name: GetCORSystemDirectory Method + href: ../../core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md + - name: GetOption Method + href: ../../core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md + - name: OpenScopeOnITypeInfo Method + href: ../../core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md + - name: SetOption Method + href: ../../core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md + - name: IMetaDataEmit interface + href: ../../core/unmanaged-api/metadata/imetadataemit-interface.md + items: + - name: ApplyEditAndContinue Method + href: ../../core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md + - name: DefineCustomAttribute Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md + - name: DefineEvent Method + href: ../../core/unmanaged-api/metadata/imetadataemit-defineevent-method.md + - name: DefineField Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definefield-method.md + - name: DefineImportMember Method + href: ../../core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md + - name: DefineImportType Method + href: ../../core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md + - name: DefineMemberRef Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definememberref-method.md + - name: DefineMethod Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definemethod-method.md + - name: DefineMethodImpl Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md + - name: DefineModuleRef Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md + - name: DefineNestedType Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md + - name: DefineParam Method + href: ../../core/unmanaged-api/metadata/imetadataemit-defineparam-method.md + - name: DefinePermissionSet Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md + - name: DefinePinvokeMap Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md + - name: DefineProperty Method + href: ../../core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md + - name: DefineSecurityAttributeSet Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md + - name: DefineTypeDef Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md + - name: DefineTypeRefByName Method + href: ../../core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md + - name: DefineUserString Method + href: ../../core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md + - name: DeleteClassLayout Method + href: ../../core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md + - name: DeleteFieldMarshal Method + href: ../../core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md + - name: DeletePinvokeMap Method + href: ../../core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md + - name: DeleteToken Method + href: ../../core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md + - name: GetSaveSize Method + href: ../../core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md + - name: GetTokenFromSig Method + href: ../../core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md + - name: GetTokenFromTypeSpec Method + href: ../../core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md + - name: Merge Method + href: ../../core/unmanaged-api/metadata/imetadataemit-merge-method.md + - name: MergeEnd Method + href: ../../core/unmanaged-api/metadata/imetadataemit-mergeend-method.md + - name: Save Method + href: ../../core/unmanaged-api/metadata/imetadataemit-save-method.md + - name: SaveToMemory Method + href: ../../core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md + - name: SaveToStream Method + href: ../../core/unmanaged-api/metadata/imetadataemit-savetostream-method.md + - name: SetClassLayout Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md + - name: SetCustomAttributeValue Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md + - name: SetEventProps Method + href: ../../core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md + - name: SetFieldMarshal Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md + - name: SetFieldProps Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md + - name: SetFieldRVA Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md + - name: SetHandler Method + href: ../../core/unmanaged-api/metadata/imetadataemit-sethandler-method.md + - name: SetMethodImplFlags Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md + - name: SetMethodProps Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md + - name: SetModuleProps Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md + - name: SetParamProps Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md + - name: SetParent Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setparent-method.md + - name: SetPermissionSetProps Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md + - name: SetPinvokeMap Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md + - name: SetPropertyProps Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md + - name: SetRVA Method + href: ../../core/unmanaged-api/metadata/imetadataemit-setrva-method.md + - name: SetTypeDefProps Method + href: ../../core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md + - name: TranslateSigWithScope Method + href: ../../core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md + - name: IMetaDataEmit2 interface + href: ../../core/unmanaged-api/metadata/imetadataemit2-interface.md + items: + - name: DefineGenericParam Method + href: ../../core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md + - name: DefineMethodSpec Method + href: ../../core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md + - name: GetDeltaSaveSize Method + href: ../../core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md + - name: ResetENCLog Method + href: ../../core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md + - name: SaveDelta Method + href: ../../core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md + - name: SaveDeltaToMemory Method + href: ../../core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md + - name: SaveDeltaToStream Method + href: ../../core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md + - name: SetGenericParamProps Method + href: ../../core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md + - name: IMetaDataError interface + href: ../../core/unmanaged-api/metadata/imetadataerror-interface.md + items: + - name: OnError Method + href: ../../core/unmanaged-api/metadata/imetadataerror-onerror-method.md + - name: IMetaDataFilter interface + href: ../../core/unmanaged-api/metadata/imetadatafilter-interface.md + items: + - name: IsTokenMarked Method + href: ../../core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md + - name: MarkToken Method + href: ../../core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md + - name: UnmarkAll Method + href: ../../core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md + - name: IMetaDataImport interface + href: ../../core/unmanaged-api/metadata/imetadataimport-interface.md + items: + - name: CloseEnum Method + href: ../../core/unmanaged-api/metadata/imetadataimport-closeenum-method.md + - name: CountEnum Method + href: ../../core/unmanaged-api/metadata/imetadataimport-countenum-method.md + - name: EnumCustomAttributes Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md + - name: EnumEvents Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumevents-method.md + - name: EnumFields Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumfields-method.md + - name: EnumFieldsWithName Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md + - name: EnumInterfaceImpls Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md + - name: EnumMemberRefs Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md + - name: EnumMembers Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enummembers-method.md + - name: EnumMembersWithName Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md + - name: EnumMethodImpls Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md + - name: EnumMethods Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enummethods-method.md + - name: EnumMethodSemantics Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md + - name: EnumMethodsWithName Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md + - name: EnumModuleRefs Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md + - name: EnumParams Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumparams-method.md + - name: EnumPermissionSets Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md + - name: EnumProperties Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md + - name: EnumSignatures Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md + - name: EnumTypeDefs Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md + - name: EnumTypeRefs Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md + - name: EnumTypeSpecs Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md + - name: EnumUnresolvedMethods Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md + - name: EnumUserStrings Method + href: ../../core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md + - name: FindField Method + href: ../../core/unmanaged-api/metadata/imetadataimport-findfield-method.md + - name: FindMember Method + href: ../../core/unmanaged-api/metadata/imetadataimport-findmember-method.md + - name: FindMemberRef Method + href: ../../core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md + - name: FindMethod Method + href: ../../core/unmanaged-api/metadata/imetadataimport-findmethod-method.md + - name: FindTypeDefByName Method + href: ../../core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md + - name: FindTypeRef Method + href: ../../core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md + - name: GetClassLayout Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md + - name: GetCustomAttributeByName Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md + - name: GetCustomAttributeProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md + - name: GetEventProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md + - name: GetFieldMarshal Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md + - name: GetFieldProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md + - name: GetInterfaceImplProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md + - name: GetMemberProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md + - name: GetMemberRefProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md + - name: GetMethodProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md + - name: GetMethodSemantics Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md + - name: GetModuleFromScope Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md + - name: GetModuleRefProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md + - name: GetNameFromToken Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md + - name: GetNativeCallConvFromSig Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md + - name: GetNestedClassProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md + - name: GetParamForMethodIndex Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md + - name: GetParamProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md + - name: GetPermissionSetProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md + - name: GetPinvokeMap + href: ../../core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md + - name: GetPropertyProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md + - name: GetRVA Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getrva-method.md + - name: GetScopeProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md + - name: GetSigFromToken Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md + - name: GetTypeDefProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md + - name: GetTypeRefProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md + - name: GetTypeSpecFromToken Method + href: ../../core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md + - name: GetUserString Method + href: ../../core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md + - name: IsGlobal Method + href: ../../core/unmanaged-api/metadata/imetadataimport-isglobal-method.md + - name: IsValidToken Method + href: ../../core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md + - name: ResetEnum Method + href: ../../core/unmanaged-api/metadata/imetadataimport-resetenum-method.md + - name: ResolveTypeRef Method + href: ../../core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md + - name: IMetaDataImport2 interface + href: ../../core/unmanaged-api/metadata/imetadataimport2-interface.md + items: + - name: EnumGenericParamConstraints Method + href: ../../core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md + - name: EnumGenericParams Method + href: ../../core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md + - name: EnumMethodSpecs Method + href: ../../core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md + - name: GetGenericParamConstraintProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md + - name: GetGenericParamProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md + - name: GetMethodSpecProps Method + href: ../../core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md + - name: GetPEKind Method + href: ../../core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md + - name: GetVersionString Method + href: ../../core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md + - name: IMetaDataInfo interface + href: ../../core/unmanaged-api/metadata/imetadatainfo-interface.md + items: + - name: GetFileMapping Method + href: ../../core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md + - name: IMetaDataTables interface + href: ../../core/unmanaged-api/metadata/imetadatatables-interface.md + items: + - name: GetBlob Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getblob-method.md + - name: GetBlobHeapSize Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md + - name: GetCodedTokenInfo Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md + - name: GetColumn Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md + - name: GetColumnInfo Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md + - name: GetGuid Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getguid-method.md + - name: GetGuidHeapSize Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md + - name: GetNextBlob Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md + - name: GetNextGuid Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md + - name: GetNextString Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md + - name: GetNextUserString Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md + - name: GetNumTables Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md + - name: GetRow Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getrow-method.md + - name: GetString Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getstring-method.md + - name: GetStringHeapSize Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md + - name: GetTableIndex Method + href: ../../core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md + - name: GetTableInfo Method + href: ../../core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md + - name: GetUserString Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md + - name: GetUserStringHeapSize Method + href: ../../core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md + - name: IMetaDataTables2 interface + href: ../../core/unmanaged-api/metadata/imetadatatables2-interface.md + items: + - name: GetMetaDataStorage Method + href: ../../core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md + - name: GetMetaDataStreamInfo Method + href: ../../core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md + - name: IMetaDataValidate interface + href: ../../core/unmanaged-api/metadata/imetadatavalidate-interface.md + items: + - name: ValidateMetaData Method + href: ../../core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md + - name: ValidatorInit Method + href: ../../core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md + - name: Enumerations + href: ../../core/unmanaged-api/metadata/metadata-enumerations.md + items: + - name: AssemblyFlags enumeration + href: ../../core/unmanaged-api/metadata/assemblyflags-enumeration.md + - name: AssemblyRefFlags enumeration + href: ../../core/unmanaged-api/metadata/assemblyrefflags-enumeration.md + - name: CeeSectionAttr enumeration + href: ../../core/unmanaged-api/metadata/ceesectionattr-enumeration.md + - name: CeeSectionRelocType enumeration + href: ../../core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md + - name: COINITICOR enumeration + href: ../../core/unmanaged-api/metadata/coiniticor-enumeration.md + - name: COINITIEE enumeration + href: ../../core/unmanaged-api/metadata/coinitiee-enumeration.md + - name: CorArgType enumeration + href: ../../core/unmanaged-api/metadata/corargtype-enumeration.md + - name: CorAssemblyFlags enumeration + href: ../../core/unmanaged-api/metadata/corassemblyflags-enumeration.md + - name: CorAttributeTargets enumeration + href: ../../core/unmanaged-api/metadata/corattributetargets-enumeration.md + - name: CorCallingConvention enumeration + href: ../../core/unmanaged-api/metadata/corcallingconvention-enumeration.md + - name: CorCheckDuplicatesFor enumeration + href: ../../core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md + - name: CorDeclSecurity enumeration + href: ../../core/unmanaged-api/metadata/cordeclsecurity-enumeration.md + - name: CorElementType enumeration1 + href: ../../core/unmanaged-api/metadata/corelementtype-enumeration.md + - name: CorErrorIfEmitOutOfOrder enumeration + href: ../../core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md + - name: CorEventAttr enumeration + href: ../../core/unmanaged-api/metadata/coreventattr-enumeration.md + - name: CorFieldAttr enumeration + href: ../../core/unmanaged-api/metadata/corfieldattr-enumeration.md + - name: CorFileFlags enumeration + href: ../../core/unmanaged-api/metadata/corfileflags-enumeration.md + - name: CorFileMapping enumeration + href: ../../core/unmanaged-api/metadata/corfilemapping-enumeration.md + - name: CorGenericParamAttr enumeration + href: ../../core/unmanaged-api/metadata/corgenericparamattr-enumeration.md + - name: CorImportOptions enumeration + href: ../../core/unmanaged-api/metadata/corimportoptions-enumeration.md + - name: CorLinkerOptions enumeration + href: ../../core/unmanaged-api/metadata/corlinkeroptions-enumeration.md + - name: CorLocalRefPreservation enumeration + href: ../../core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md + - name: CorManifestResourceFlags enumeration + href: ../../core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md + - name: CorMethodAttr enumeration + href: ../../core/unmanaged-api/metadata/cormethodattr-enumeration.md + - name: CorMethodImpl enumeration + href: ../../core/unmanaged-api/metadata/cormethodimpl-enumeration.md + - name: CorMethodSemanticsAttr enumeration + href: ../../core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md + - name: CorNativeLinkFlags enumeration + href: ../../core/unmanaged-api/metadata/cornativelinkflags-enumeration.md + - name: CorNativeLinkType enumeration + href: ../../core/unmanaged-api/metadata/cornativelinktype-enumeration.md + - name: CorNativeType enumeration + href: ../../core/unmanaged-api/metadata/cornativetype-enumeration.md + - name: CorNotificationForTokenMovement enumeration + href: ../../core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md + - name: CorOpenFlags enumeration + href: ../../core/unmanaged-api/metadata/coropenflags-enumeration.md + - name: CorParamAttr enumeration + href: ../../core/unmanaged-api/metadata/corparamattr-enumeration.md + - name: CorPEKind enumeration + href: ../../core/unmanaged-api/metadata/corpekind-enumeration.md + - name: CorPinvokeMap enumeration + href: ../../core/unmanaged-api/metadata/corpinvokemap-enumeration.md + - name: CorPropertyAttr enumeration + href: ../../core/unmanaged-api/metadata/corpropertyattr-enumeration.md + - name: CorRefToDefCheck enumeration + href: ../../core/unmanaged-api/metadata/correftodefcheck-enumeration.md + - name: CorRegFlags enumeration + href: ../../core/unmanaged-api/metadata/corregflags-enumeration.md + - name: CorSaveSize enumeration + href: ../../core/unmanaged-api/metadata/corsavesize-enumeration.md + - name: CorSerializationType enumeration + href: ../../core/unmanaged-api/metadata/corserializationtype-enumeration.md + - name: CorSetENC enumeration + href: ../../core/unmanaged-api/metadata/corsetenc-enumeration.md + - name: CorThreadSafetyOptions enumeration + href: ../../core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md + - name: CorTokenType enumeration + href: ../../core/unmanaged-api/metadata/cortokentype-enumeration.md + - name: CorTypeAttr enumeration + href: ../../core/unmanaged-api/metadata/cortypeattr-enumeration.md + - name: CorUnmanagedCallingConvention enumeration + href: ../../core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md + - name: CorValidatorModuleType enumeration + href: ../../core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md + - name: COUNINITIEE enumeration + href: ../../core/unmanaged-api/metadata/couninitiee-enumeration.md + - name: Structures + href: ../../core/unmanaged-api/metadata/metadata-structures.md + items: + - name: ASSEMBLYMETADATA structure + href: ../../core/unmanaged-api/metadata/assemblymetadata-structure.md + - name: COR_FIELD_OFFSET structure + href: ../../core/unmanaged-api/metadata/cor-field-offset-structure.md + - name: COR_NATIVE_LINK structure + href: ../../core/unmanaged-api/metadata/cor-native-link-structure.md + - name: CVStruct structure + href: ../../core/unmanaged-api/metadata/cvstruct-structure.md + - name: OSINFO structure + href: ../../core/unmanaged-api/metadata/osinfo-structure.md + - name: Unions + href: ../../core/unmanaged-api/metadata/metadata-unions.md + items: + - name: CeeSectionRelocExtra union + href: ../../core/unmanaged-api/metadata/ceesectionrelocextra-union.md - name: Profiling items: - name: Overview